blob: 9038f28c3ba7ee6cd607978bf582b7262b9a8170 [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;<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.architecture.ComponentTypeDescription;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.parser.PojoMetadata;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.osgi.framework.Bundle;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Dictionary;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.HashSet;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Set;<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 class defines the description of primitive (non-composite) component<a name="line.33"></a>
<span class="sourceLineNo">034</span> * types. An instance of this class will be returned when invoking the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link org.apache.felix.ipojo.ComponentFactory#getComponentDescription()} method.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>final class PrimitiveTypeDescription extends ComponentTypeDescription {<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Set to keep component's all super-class class-names.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> private Set&lt;String&gt; m_superClasses = new HashSet&lt;String&gt;();<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Set to keep component's all interface class-names.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> private Set&lt;String&gt; m_interfaces = new HashSet&lt;String&gt;();<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * The described component factory.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> private ComponentFactory m_factory;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Creates a PrimitiveTypeDescription object.<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param factory the m_factory attached to this component type description.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public PrimitiveTypeDescription(ComponentFactory factory) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> super(factory);<a name="line.62"></a>
<span class="sourceLineNo">063</span> this.m_factory = factory;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> try {<a name="line.65"></a>
<span class="sourceLineNo">066</span> // The inspection can be done only for primitive components<a name="line.66"></a>
<span class="sourceLineNo">067</span> if (factory.getClassName() != null) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> // Read inherited classes and interfaces into given Sets.<a name="line.68"></a>
<span class="sourceLineNo">069</span> new InheritanceInspector(factory.getPojoMetadata(), getBundleContext().getBundle()).<a name="line.69"></a>
<span class="sourceLineNo">070</span> computeInterfacesAndSuperClasses(m_interfaces, m_superClasses);<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span> } catch (ClassNotFoundException e) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> m_interfaces.clear();<a name="line.73"></a>
<span class="sourceLineNo">074</span> m_superClasses.clear();<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> }<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> * Computes the properties to publish.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * The &lt;code&gt;component.class&lt;/code&gt; property contains the implementation class name.<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @return the dictionary of properties to publish<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @see org.apache.felix.ipojo.architecture.ComponentTypeDescription#getPropertiesToPublish()<a name="line.84"></a>
<span class="sourceLineNo">085</span> */<a name="line.85"></a>
<span class="sourceLineNo">086</span> public Dictionary&lt;String, Object&gt; getPropertiesToPublish() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> Dictionary&lt;String, Object&gt; dict = super.getPropertiesToPublish();<a name="line.87"></a>
<span class="sourceLineNo">088</span> if (m_factory.getClassName() != null) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> dict.put("component.class", m_factory.getClassName());<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> return dict;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Adds the "implementation-class" attribute to the type description.<a name="line.95"></a>
<span class="sourceLineNo">096</span> *<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @return the component type description.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @see org.apache.felix.ipojo.architecture.ComponentTypeDescription#getDescription()<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> public Element getDescription() {<a name="line.100"></a>
<span class="sourceLineNo">101</span> Element elem = super.getDescription();<a name="line.101"></a>
<span class="sourceLineNo">102</span> elem.addAttribute(new Attribute("Implementation-Class", m_factory.getClassName()));<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> /* Adding interfaces and super-classes of component into description */<a name="line.104"></a>
<span class="sourceLineNo">105</span> Element inheritance = new Element("Inherited", "");<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> inheritance.addAttribute(new Attribute("Interfaces", m_interfaces.toString()));<a name="line.107"></a>
<span class="sourceLineNo">108</span> inheritance.addAttribute(new Attribute("SuperClasses", m_superClasses.toString()));<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> elem.addElement(inheritance);<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> return elem;<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> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * This class is used to collect interfaces and super-classes of given component in specified Sets.<a name="line.116"></a>
<span class="sourceLineNo">117</span> *<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> private final class InheritanceInspector {<a name="line.120"></a>
<span class="sourceLineNo">121</span> /*<a name="line.121"></a>
<span class="sourceLineNo">122</span> * PojoMetadata of target Component.<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> private PojoMetadata m_pojoMetadata;<a name="line.124"></a>
<span class="sourceLineNo">125</span> /*<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Bundle exposing target component.<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> private Bundle m_bundle;<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> /**<a name="line.131"></a>
<span class="sourceLineNo">132</span> * Creates a TypeCollector object<a name="line.132"></a>
<span class="sourceLineNo">133</span> *<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @param pojoMetadata PojoMetadata describing Component.<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @param bundle Bundle which has been exposed the intended Component.<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> public InheritanceInspector(PojoMetadata pojoMetadata, Bundle bundle) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> m_pojoMetadata = pojoMetadata;<a name="line.138"></a>
<span class="sourceLineNo">139</span> m_bundle = bundle;<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> * Collect interfaces implemented by the POJO into given Sets.<a name="line.143"></a>
<span class="sourceLineNo">144</span> *<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @param interfaces : the set of implemented interfaces<a name="line.145"></a>
<span class="sourceLineNo">146</span> * @param classes : the set of extended classes<a name="line.146"></a>
<span class="sourceLineNo">147</span> * @throws ClassNotFoundException : occurs when an interface cannot be loaded.<a name="line.147"></a>
<span class="sourceLineNo">148</span> */<a name="line.148"></a>
<span class="sourceLineNo">149</span> public void computeInterfacesAndSuperClasses(Set&lt;String&gt; interfaces, Set&lt;String&gt; classes) throws ClassNotFoundException {<a name="line.149"></a>
<span class="sourceLineNo">150</span> String[] immediateInterfaces = m_pojoMetadata.getInterfaces();<a name="line.150"></a>
<span class="sourceLineNo">151</span> String parentClass = m_pojoMetadata.getSuperClass();<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> // First iterate on found specification in manipulation metadata<a name="line.153"></a>
<span class="sourceLineNo">154</span> for (String immediateInterface : immediateInterfaces) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> interfaces.add(immediateInterface);<a name="line.155"></a>
<span class="sourceLineNo">156</span> // Iterate on interfaces implemented by the current interface<a name="line.156"></a>
<span class="sourceLineNo">157</span> Class&lt;?&gt; clazz = m_bundle.loadClass(immediateInterface);<a name="line.157"></a>
<span class="sourceLineNo">158</span> collectInterfaces(clazz, interfaces, m_bundle);<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> // Look for parent class.<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (parentClass != null) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> Class clazz = m_bundle.loadClass(parentClass);<a name="line.163"></a>
<span class="sourceLineNo">164</span> collectInterfacesFromClass(clazz, interfaces, m_bundle);<a name="line.164"></a>
<span class="sourceLineNo">165</span> classes.add(parentClass);<a name="line.165"></a>
<span class="sourceLineNo">166</span> collectParentClassesFromClass(clazz, classes, m_bundle);<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> // Removing Object Class from the inherited classes list.<a name="line.169"></a>
<span class="sourceLineNo">170</span> classes.remove(Object.class.getName());<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Look for inherited interfaces.<a name="line.174"></a>
<span class="sourceLineNo">175</span> *<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @param clazz : interface name to explore (class object)<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @param acc : set (accumulator)<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @param bundle : bundle<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @throws ClassNotFoundException : occurs when an interface cannot be loaded.<a name="line.179"></a>
<span class="sourceLineNo">180</span> */<a name="line.180"></a>
<span class="sourceLineNo">181</span> private void collectInterfaces(Class&lt;?&gt; clazz, Set&lt;String&gt; acc, Bundle bundle) throws ClassNotFoundException {<a name="line.181"></a>
<span class="sourceLineNo">182</span> Class[] clazzes = clazz.getInterfaces();<a name="line.182"></a>
<span class="sourceLineNo">183</span> for (Class clazze : clazzes) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> acc.add(clazze.getName());<a name="line.184"></a>
<span class="sourceLineNo">185</span> collectInterfaces(clazze, acc, bundle);<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> /**<a name="line.189"></a>
<span class="sourceLineNo">190</span> * Collect interfaces for the given class.<a name="line.190"></a>
<span class="sourceLineNo">191</span> * This method explores super class to.<a name="line.191"></a>
<span class="sourceLineNo">192</span> *<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @param clazz : class object.<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param acc : set of implemented interface (accumulator)<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param bundle : bundle.<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @throws ClassNotFoundException : occurs if an interface cannot be load.<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> private void collectInterfacesFromClass(Class&lt;?&gt; clazz, Set&lt;String&gt; acc,<a name="line.198"></a>
<span class="sourceLineNo">199</span> Bundle bundle) throws ClassNotFoundException {<a name="line.199"></a>
<span class="sourceLineNo">200</span> Class[] clazzes = clazz.getInterfaces();<a name="line.200"></a>
<span class="sourceLineNo">201</span> for (Class clazze : clazzes) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> acc.add(clazze.getName());<a name="line.202"></a>
<span class="sourceLineNo">203</span> collectInterfaces(clazze, acc, bundle);<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> // Iterate on parent classes<a name="line.205"></a>
<span class="sourceLineNo">206</span> Class sup = clazz.getSuperclass();<a name="line.206"></a>
<span class="sourceLineNo">207</span> if (sup != null) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> collectInterfacesFromClass(sup, acc, bundle);<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
<span class="sourceLineNo">213</span> * Collect parent classes for the given class.<a name="line.213"></a>
<span class="sourceLineNo">214</span> *<a name="line.214"></a>
<span class="sourceLineNo">215</span> * @param clazz : class object.<a name="line.215"></a>
<span class="sourceLineNo">216</span> * @param acc : set of extended classes (accumulator)<a name="line.216"></a>
<span class="sourceLineNo">217</span> * @param bundle : bundle.<a name="line.217"></a>
<span class="sourceLineNo">218</span> * @throws ClassNotFoundException : occurs if an interface cannot be load.<a name="line.218"></a>
<span class="sourceLineNo">219</span> */<a name="line.219"></a>
<span class="sourceLineNo">220</span> private void collectParentClassesFromClass(Class&lt;?&gt; clazz, Set&lt;String&gt; acc, Bundle bundle) throws ClassNotFoundException {<a name="line.220"></a>
<span class="sourceLineNo">221</span> Class&lt;?&gt; parent = clazz.getSuperclass();<a name="line.221"></a>
<span class="sourceLineNo">222</span> if (parent != null) {<a name="line.222"></a>
<span class="sourceLineNo">223</span> acc.add(parent.getName());<a name="line.223"></a>
<span class="sourceLineNo">224</span> collectParentClassesFromClass(parent, acc, bundle);<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span>}<a name="line.228"></a>
</pre>
</div>
</body>
</html>