Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.10.1 / src-html / org / apache / felix / ipojo / handlers / lifecycle / callback / LifecycleCallbackHandler.html
blob: 08682c4dc7cdfa7f195d1a0dc8eaaea574956f45 [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.handlers.lifecycle.callback;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.lang.reflect.InvocationTargetException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Dictionary;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.ComponentInstance;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.ConfigurationException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.InstanceManager;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.felix.ipojo.PrimitiveHandler;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.felix.ipojo.parser.MethodMetadata;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.felix.ipojo.parser.PojoMetadata;<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> * Lifecycle callback handler.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * <a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public class LifecycleCallbackHandler extends PrimitiveHandler {<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> * The list of the callback of the component.<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> private LifecycleCallback[] m_callbacks = new LifecycleCallback[0];<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * State of the instance manager (unresolved at the beginning).<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> private int m_state = InstanceManager.INVALID;<a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Does a POJO object be created at starting.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> private boolean m_immediate = false;<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> * Add the given callback to the callback list.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * <a name="line.55"></a>
<span class="sourceLineNo">056</span> * @param callback : the element to add<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> private void addCallback(LifecycleCallback callback) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> for (int i = 0; (m_callbacks != null) &amp;&amp; (i &lt; m_callbacks.length); i++) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> if (m_callbacks[i] == callback) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> return;<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<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> if (m_callbacks != null &amp;&amp; m_callbacks.length &gt; 0) { //TODO check here if we can improve the test<a name="line.65"></a>
<span class="sourceLineNo">066</span> LifecycleCallback[] newHk = new LifecycleCallback[m_callbacks.length + 1];<a name="line.66"></a>
<span class="sourceLineNo">067</span> System.arraycopy(m_callbacks, 0, newHk, 0, m_callbacks.length);<a name="line.67"></a>
<span class="sourceLineNo">068</span> newHk[m_callbacks.length] = callback;<a name="line.68"></a>
<span class="sourceLineNo">069</span> m_callbacks = newHk;<a name="line.69"></a>
<span class="sourceLineNo">070</span> } else {<a name="line.70"></a>
<span class="sourceLineNo">071</span> m_callbacks = new LifecycleCallback[] { callback };<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><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Configure the handler.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param metadata : the component type metadata<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param configuration : the instance configuration<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @throws ConfigurationException : one callback metadata is not correct (either the transition or the method are not correct).<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @see org.apache.felix.ipojo.Handler#configure(org.apache.felix.ipojo.InstanceManager, org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void configure(Element metadata, Dictionary configuration) throws ConfigurationException {<a name="line.82"></a>
<span class="sourceLineNo">083</span> m_callbacks = new LifecycleCallback[0];<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> String imm = metadata.getAttribute("immediate");<a name="line.85"></a>
<span class="sourceLineNo">086</span> m_immediate = imm != null &amp;&amp; imm.equalsIgnoreCase("true");<a name="line.86"></a>
<span class="sourceLineNo">087</span> <a name="line.87"></a>
<span class="sourceLineNo">088</span> PojoMetadata meta = getFactory().getPojoMetadata();<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> Element[] hooksMetadata = metadata.getElements("callback");<a name="line.90"></a>
<span class="sourceLineNo">091</span> for (int i = 0; hooksMetadata != null &amp;&amp; i &lt; hooksMetadata.length; i++) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> String method = hooksMetadata[i].getAttribute("method");<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (method == null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> throw new ConfigurationException("Lifecycle callback : A callback needs to contain a method attribute");<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> MethodMetadata met = meta.getMethod(method, new String[0]);<a name="line.97"></a>
<span class="sourceLineNo">098</span> <a name="line.98"></a>
<span class="sourceLineNo">099</span> int transition = -1;<a name="line.99"></a>
<span class="sourceLineNo">100</span> String trans = hooksMetadata[i].getAttribute("transition");<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (trans == null) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> throw new ConfigurationException("Lifecycle callback : the transition attribute is missing");<a name="line.102"></a>
<span class="sourceLineNo">103</span> } else {<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (trans.equalsIgnoreCase("validate")) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> transition = LifecycleCallback.VALIDATE;<a name="line.105"></a>
<span class="sourceLineNo">106</span> } else if (trans.equalsIgnoreCase("invalidate")) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> transition = LifecycleCallback.INVALIDATE; <a name="line.107"></a>
<span class="sourceLineNo">108</span> } else {<a name="line.108"></a>
<span class="sourceLineNo">109</span> throw new ConfigurationException("Lifecycle callback : Unknown or malformed transition : " + trans);<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> <a name="line.112"></a>
<span class="sourceLineNo">113</span> LifecycleCallback callback = null;<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (met == null) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> callback = new LifecycleCallback(this, transition, method);<a name="line.115"></a>
<span class="sourceLineNo">116</span> } else {<a name="line.116"></a>
<span class="sourceLineNo">117</span> callback = new LifecycleCallback(this, transition, met);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> addCallback(callback);<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<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> /**<a name="line.123"></a>
<span class="sourceLineNo">124</span> * Start the handler. <a name="line.124"></a>
<span class="sourceLineNo">125</span> * @see org.apache.felix.ipojo.Handler#start()<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> public void start() {<a name="line.127"></a>
<span class="sourceLineNo">128</span> // Do nothing during the start<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> * Stop the handler.<a name="line.132"></a>
<span class="sourceLineNo">133</span> * @see org.apache.felix.ipojo.Handler#stop()<a name="line.133"></a>
<span class="sourceLineNo">134</span> */<a name="line.134"></a>
<span class="sourceLineNo">135</span> public void stop() {<a name="line.135"></a>
<span class="sourceLineNo">136</span> m_state = InstanceManager.INVALID;<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /**<a name="line.139"></a>
<span class="sourceLineNo">140</span> * When the state change call the associated callback.<a name="line.140"></a>
<span class="sourceLineNo">141</span> * <a name="line.141"></a>
<span class="sourceLineNo">142</span> * @param state : the new instance state.<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @see org.apache.felix.ipojo.Handler#stateChanged(int)<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> public void stateChanged(int state) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> int transition = -1;<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (m_state == ComponentInstance.INVALID &amp;&amp; state == ComponentInstance.VALID) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> transition = LifecycleCallback.VALIDATE;<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (m_state == ComponentInstance.VALID &amp;&amp; state == ComponentInstance.INVALID) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> transition = LifecycleCallback.INVALIDATE;<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> // Manage immediate component<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (m_immediate &amp;&amp; transition == LifecycleCallback.VALIDATE &amp;&amp; getInstanceManager().getPojoObjects() == null) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> getInstanceManager().getPojoObject();<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> for (int i = 0; i &lt; m_callbacks.length; i++) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> if (m_callbacks[i].getTransition() == transition) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> try {<a name="line.161"></a>
<span class="sourceLineNo">162</span> m_callbacks[i].call();<a name="line.162"></a>
<span class="sourceLineNo">163</span> } catch (NoSuchMethodException e) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> error("[" + getInstanceManager().getInstanceName() + "] The callback method " + m_callbacks[i].getMethod() + " is not found");<a name="line.164"></a>
<span class="sourceLineNo">165</span> throw new IllegalStateException(e);<a name="line.165"></a>
<span class="sourceLineNo">166</span> } catch (IllegalAccessException e) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> error("[" + getInstanceManager().getInstanceName() + "] The callback method " + m_callbacks[i].getMethod() + " is not accessible");<a name="line.167"></a>
<span class="sourceLineNo">168</span> throw new IllegalStateException(e);<a name="line.168"></a>
<span class="sourceLineNo">169</span> } catch (InvocationTargetException e) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> error("[" + getInstanceManager().getInstanceName() + "] The callback method " + m_callbacks[i].getMethod() + " has thrown an exception : " + e.getTargetException().getMessage(), e.getTargetException());<a name="line.170"></a>
<span class="sourceLineNo">171</span> throw new IllegalStateException(e.getTargetException());<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> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> // Update to internal state<a name="line.175"></a>
<span class="sourceLineNo">176</span> m_state = state;<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>
</pre>
</div>
</body>
</html>