Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.11.0 / src-html / org / apache / felix / ipojo / util / DependencyMetadataHelper.html
blob: 776caa1723841d14b21b3b2fd8f8dfb39ef4f5d0 [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.util;<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.ConfigurationException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.osgi.framework.BundleContext;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Comparator;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A set of methods to simplify the parsing of dependency attributes.<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span>public class DependencyMetadataHelper {<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> /**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Helper method parsing the comparator attribute and returning the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * comparator object. If the 'comparator' attribute is not set, this method<a name="line.36"></a>
<span class="sourceLineNo">037</span> * returns null. If the 'comparator' attribute is set to 'osgi', this method<a name="line.37"></a>
<span class="sourceLineNo">038</span> * returns the normal OSGi comparator. In other case, it tries to create<a name="line.38"></a>
<span class="sourceLineNo">039</span> * an instance of the declared comparator class.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @param dep the Element describing the dependency<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @param context the bundle context (to load the comparator class)<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @return the comparator object, &lt;code&gt;null&lt;/code&gt; if not set.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @throws org.apache.felix.ipojo.ConfigurationException the comparator class cannot be load or the<a name="line.44"></a>
<span class="sourceLineNo">045</span> * comparator cannot be instantiated correctly.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static Comparator getComparator(Element dep, BundleContext context) throws ConfigurationException {<a name="line.47"></a>
<span class="sourceLineNo">048</span> Comparator cmp = null;<a name="line.48"></a>
<span class="sourceLineNo">049</span> String comp = dep.getAttribute("comparator");<a name="line.49"></a>
<span class="sourceLineNo">050</span> if (comp != null) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (comp.equalsIgnoreCase("osgi")) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> cmp = new ServiceReferenceRankingComparator();<a name="line.52"></a>
<span class="sourceLineNo">053</span> } else {<a name="line.53"></a>
<span class="sourceLineNo">054</span> try {<a name="line.54"></a>
<span class="sourceLineNo">055</span> Class cla = context.getBundle().loadClass(comp);<a name="line.55"></a>
<span class="sourceLineNo">056</span> cmp = (Comparator) cla.newInstance();<a name="line.56"></a>
<span class="sourceLineNo">057</span> } catch (ClassNotFoundException e) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> throw new ConfigurationException("Cannot load a customized comparator", e);<a name="line.58"></a>
<span class="sourceLineNo">059</span> } catch (IllegalAccessException e) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> throw new ConfigurationException("Cannot create a customized comparator", e);<a name="line.60"></a>
<span class="sourceLineNo">061</span> } catch (InstantiationException e) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> throw new ConfigurationException("Cannot create a customized comparator", e);<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> return cmp;<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<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> * Loads the given specification class.<a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param specification the specification class name to load<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param context the bundle context<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @return the class object for the given specification<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @throws org.apache.felix.ipojo.ConfigurationException if the class cannot be loaded correctly.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public static Class loadSpecification(String specification, BundleContext context) throws ConfigurationException {<a name="line.77"></a>
<span class="sourceLineNo">078</span> Class spec;<a name="line.78"></a>
<span class="sourceLineNo">079</span> try {<a name="line.79"></a>
<span class="sourceLineNo">080</span> spec = context.getBundle().loadClass(specification);<a name="line.80"></a>
<span class="sourceLineNo">081</span> } catch (ClassNotFoundException e) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> throw new ConfigurationException("A required specification cannot be loaded : " + specification, e);<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> return spec;<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Helper method parsing the binding policy.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * If the 'policy' attribute is not set in the dependency, the method returns<a name="line.89"></a>
<span class="sourceLineNo">090</span> * the 'DYNAMIC BINDING POLICY'. Accepted policy values are : dynamic,<a name="line.90"></a>
<span class="sourceLineNo">091</span> * dynamic-priority and static.<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param dep the Element describing the dependency<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @return the policy attached to this dependency<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @throws org.apache.felix.ipojo.ConfigurationException if an unknown binding policy was described.<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> public static int getPolicy(Element dep) throws ConfigurationException {<a name="line.97"></a>
<span class="sourceLineNo">098</span> String policy = dep.getAttribute("policy");<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (policy == null || policy.equalsIgnoreCase("dynamic")) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return DependencyModel.DYNAMIC_BINDING_POLICY;<a name="line.100"></a>
<span class="sourceLineNo">101</span> } else if (policy.equalsIgnoreCase("dynamic-priority")) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return DependencyModel.DYNAMIC_PRIORITY_BINDING_POLICY;<a name="line.102"></a>
<span class="sourceLineNo">103</span> } else if (policy.equalsIgnoreCase("static")) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return DependencyModel.STATIC_BINDING_POLICY;<a name="line.104"></a>
<span class="sourceLineNo">105</span> } else {<a name="line.105"></a>
<span class="sourceLineNo">106</span> throw new ConfigurationException("Binding policy unknown : " + policy);<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>}<a name="line.109"></a>
</pre>
</div>
</body>
</html>