Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.12.1 / src-html / org / apache / felix / ipojo / architecture / InstanceDescription.html
blob: 4a49c2b5ef8b0da8c82a36d55529e958aa017e62 [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.architecture;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.felix.ipojo.ComponentInstance;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.felix.ipojo.InstanceStateListener;<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><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Instance Description.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * <a name="line.28"></a>
<span class="sourceLineNo">029</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span>public class InstanceDescription implements InstanceStateListener {<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> * The list of handlers plugged on the component instance.<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span> protected HandlerDescription[] m_handlers;<a name="line.36"></a>
<span class="sourceLineNo">037</span> <a name="line.37"></a>
<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * The Underlying component instance.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> protected final ComponentInstance m_instance;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * Component Type of the instance.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> protected final ComponentTypeDescription m_type;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Creates the instance description.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param ci the state of the instance.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @param desc the component type description of this instance.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public InstanceDescription(ComponentTypeDescription desc, ComponentInstance ci) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> m_handlers = new HandlerDescription[0];<a name="line.54"></a>
<span class="sourceLineNo">055</span> m_type = desc;<a name="line.55"></a>
<span class="sourceLineNo">056</span> m_instance = ci;<a name="line.56"></a>
<span class="sourceLineNo">057</span> m_instance.addInstanceStateListener(this);<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<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> * Gets the underlying component instance<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @return the component instance.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> public ComponentInstance getInstance() {<a name="line.64"></a>
<span class="sourceLineNo">065</span> return m_instance;<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<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> * Gets the instance name.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @return the name of the instance.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public String getName() {<a name="line.72"></a>
<span class="sourceLineNo">073</span> return m_instance.getInstanceName();<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<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> * Gets the component type description of the described instance.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @return : the component type description of this instance.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> public ComponentTypeDescription getComponentDescription() {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return m_type;<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> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Gets the plugged handler list.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @return the live handler list<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public HandlerDescription[] getHandlers() {<a name="line.88"></a>
<span class="sourceLineNo">089</span> return m_handlers;<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Adds an handler description to the list.<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param desc : the handler description to add<a name="line.94"></a>
<span class="sourceLineNo">095</span> */<a name="line.95"></a>
<span class="sourceLineNo">096</span> public void addHandler(HandlerDescription desc) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> // Verify that the dependency description is not already in the array.<a name="line.97"></a>
<span class="sourceLineNo">098</span> for (HandlerDescription handler : m_handlers) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (handler == desc) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return; // NOTHING TO DO, the description is already in the<a name="line.100"></a>
<span class="sourceLineNo">101</span> // array<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> // The component Description is not in the array, add it<a name="line.104"></a>
<span class="sourceLineNo">105</span> HandlerDescription[] newHd = new HandlerDescription[m_handlers.length + 1];<a name="line.105"></a>
<span class="sourceLineNo">106</span> System.arraycopy(m_handlers, 0, newHd, 0, m_handlers.length);<a name="line.106"></a>
<span class="sourceLineNo">107</span> newHd[m_handlers.length] = desc;<a name="line.107"></a>
<span class="sourceLineNo">108</span> m_handlers = newHd;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> <a name="line.110"></a>
<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
<span class="sourceLineNo">112</span> * Gets a handler description by specifying the handler qualified name.<a name="line.112"></a>
<span class="sourceLineNo">113</span> * This method ignores case of the given handler name.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @param handler the handler name<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @return the handler description or &lt;code&gt;null&lt;/code&gt; if not found<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> public HandlerDescription getHandlerDescription(String handler) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> for (HandlerDescription description : m_handlers) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (description.getHandlerName().equalsIgnoreCase(handler)) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return description;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> return null;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Gets the state of the described instance.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @return the state of the instance.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> public int getState() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> waitForStability();<a name="line.131"></a>
<span class="sourceLineNo">132</span> return m_instance.getState();<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> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Gets the bundle id of the bundle containing the component type of the instance.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @return the bundle id owning the component implementation class.<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public long getBundleId() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return m_instance.getFactory().getBundleContext().getBundle().getBundleId();<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> /**<a name="line.143"></a>
<span class="sourceLineNo">144</span> * Gets the instance description.<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @return the instance description<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> public Element getDescription() {<a name="line.147"></a>
<span class="sourceLineNo">148</span> Element instance = new Element("Instance", "");<a name="line.148"></a>
<span class="sourceLineNo">149</span> instance.addAttribute(new Attribute("name", getName())); // Name<a name="line.149"></a>
<span class="sourceLineNo">150</span> <a name="line.150"></a>
<span class="sourceLineNo">151</span> int state = getState();<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (state == ComponentInstance.STOPPED) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> instance.addAttribute(new Attribute("state", "stopped"));<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (state == ComponentInstance.VALID) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> instance.addAttribute(new Attribute("state", "valid"));<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (state == ComponentInstance.INVALID) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> instance.addAttribute(new Attribute("state", "invalid"));<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (state == ComponentInstance.DISPOSED) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> instance.addAttribute(new Attribute("state", "disposed"));<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> // Bundle<a name="line.164"></a>
<span class="sourceLineNo">165</span> instance.addAttribute(new Attribute("bundle", Long.toString(getBundleId())));<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> // Component Type<a name="line.167"></a>
<span class="sourceLineNo">168</span> instance.addAttribute(new Attribute("component.type", m_type.getName()));<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> // Handlers<a name="line.170"></a>
<span class="sourceLineNo">171</span> for (HandlerDescription description : m_handlers) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> instance.addElement(description.getHandlerInfo());<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> return instance;<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> /**<a name="line.179"></a>
<span class="sourceLineNo">180</span> * Waits for state stability before returning results.<a name="line.180"></a>
<span class="sourceLineNo">181</span> */<a name="line.181"></a>
<span class="sourceLineNo">182</span> private synchronized void waitForStability() {<a name="line.182"></a>
<span class="sourceLineNo">183</span> while (m_instance.getState() == -2) { // Transition<a name="line.183"></a>
<span class="sourceLineNo">184</span> try {<a name="line.184"></a>
<span class="sourceLineNo">185</span> wait();<a name="line.185"></a>
<span class="sourceLineNo">186</span> } catch (InterruptedException e) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> // We're interrupted, will re-check the condition.<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> <a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span> /**<a name="line.193"></a>
<span class="sourceLineNo">194</span> * The underlying instance state changes.<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param instance the instance<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @param newState the new state<a name="line.196"></a>
<span class="sourceLineNo">197</span> * @see org.apache.felix.ipojo.InstanceStateListener#stateChanged(org.apache.felix.ipojo.ComponentInstance, int)<a name="line.197"></a>
<span class="sourceLineNo">198</span> */<a name="line.198"></a>
<span class="sourceLineNo">199</span> public synchronized void stateChanged(ComponentInstance instance, int newState) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> notifyAll(); // if we were in a transition, the transition has completed.<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span>}<a name="line.203"></a>
</pre>
</div>
</body>
</html>