http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f8d6f420/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html index 748314e..6dcf0c1 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureIterator.html @@ -30,157 +30,173 @@ <span class="sourceLineNo">022</span><a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.procedure2.Procedure;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>/**<a name="line.27"></a> -<span class="sourceLineNo">028</span> * The ProcedureStore is used by the executor to persist the state of each procedure execution.<a name="line.28"></a> -<span class="sourceLineNo">029</span> * This allows to resume the execution of pending/in-progress procedures in case<a name="line.29"></a> -<span class="sourceLineNo">030</span> * of machine failure or service shutdown.<a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceStability.Evolving<a name="line.33"></a> -<span class="sourceLineNo">034</span>public interface ProcedureStore {<a name="line.34"></a> -<span class="sourceLineNo">035</span> /**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Store listener interface.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * The main process should register a listener and respond to the store events.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> public interface ProcedureStoreListener {<a name="line.39"></a> -<span class="sourceLineNo">040</span> /**<a name="line.40"></a> -<span class="sourceLineNo">041</span> * triggered when the store sync is completed.<a name="line.41"></a> -<span class="sourceLineNo">042</span> */<a name="line.42"></a> -<span class="sourceLineNo">043</span> void postSync();<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * triggered when the store is not able to write out data.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * the main process should abort.<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> void abortProcess();<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> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * An Iterator over a collection of Procedure<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> public interface ProcedureIterator {<a name="line.55"></a> -<span class="sourceLineNo">056</span> /**<a name="line.56"></a> -<span class="sourceLineNo">057</span> * Reset the Iterator by seeking to the beginning of the list.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> void reset();<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> /**<a name="line.61"></a> -<span class="sourceLineNo">062</span> * Returns true if the iterator has more elements.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * (In other words, returns true if next() would return a Procedure<a name="line.63"></a> -<span class="sourceLineNo">064</span> * rather than throwing an exception.)<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @return true if the iterator has more procedures<a name="line.65"></a> -<span class="sourceLineNo">066</span> */<a name="line.66"></a> -<span class="sourceLineNo">067</span> boolean hasNext();<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> * Returns the next procedure in the iteration.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @return the next procedure in the iteration.<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> Procedure next() throws IOException;<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> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> public interface ProcedureLoader {<a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param maxProcId the highest proc-id in the store<a name="line.83"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.ProcedureInfo;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.procedure2.Procedure;<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> * The ProcedureStore is used by the executor to persist the state of each procedure execution.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * This allows to resume the execution of pending/in-progress procedures in case<a name="line.30"></a> +<span class="sourceLineNo">031</span> * of machine failure or service shutdown.<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> +<span class="sourceLineNo">034</span>@InterfaceStability.Evolving<a name="line.34"></a> +<span class="sourceLineNo">035</span>public interface ProcedureStore {<a name="line.35"></a> +<span class="sourceLineNo">036</span> /**<a name="line.36"></a> +<span class="sourceLineNo">037</span> * Store listener interface.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * The main process should register a listener and respond to the store events.<a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span> public interface ProcedureStoreListener {<a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * triggered when the store sync is completed.<a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> void postSync();<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> * triggered when the store is not able to write out data.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * the main process should abort.<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> void abortProcess();<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<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> * An Iterator over a collection of Procedure<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public interface ProcedureIterator {<a name="line.56"></a> +<span class="sourceLineNo">057</span> /**<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Reset the Iterator by seeking to the beginning of the list.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> void reset();<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> /**<a name="line.62"></a> +<span class="sourceLineNo">063</span> * Returns true if the iterator has more elements.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * (In other words, returns true if next() would return a Procedure<a name="line.64"></a> +<span class="sourceLineNo">065</span> * rather than throwing an exception.)<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @return true if the iterator has more procedures<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> boolean hasNext();<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @return true if the iterator next element is a completed procedure.<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> boolean isNextCompleted();<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> * Skip the next procedure<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> void skipNext();<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Returns the next procedure in the iteration.<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return the next procedure in the iteration.<a name="line.83"></a> <span class="sourceLineNo">084</span> */<a name="line.84"></a> -<span class="sourceLineNo">085</span> void setMaxProcId(long maxProcId);<a name="line.85"></a> +<span class="sourceLineNo">085</span> Procedure nextAsProcedure() throws IOException;<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> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.88"></a> -<span class="sourceLineNo">089</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.90"></a> -<span class="sourceLineNo">091</span> */<a name="line.91"></a> -<span class="sourceLineNo">092</span> void load(ProcedureIterator procIter) throws IOException;<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> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.95"></a> -<span class="sourceLineNo">096</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.96"></a> -<span class="sourceLineNo">097</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.97"></a> -<span class="sourceLineNo">098</span> */<a name="line.98"></a> -<span class="sourceLineNo">099</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.99"></a> -<span class="sourceLineNo">100</span> }<a name="line.100"></a> -<span class="sourceLineNo">101</span><a name="line.101"></a> -<span class="sourceLineNo">102</span> /**<a name="line.102"></a> -<span class="sourceLineNo">103</span> * Add the listener to the notification list.<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @param listener The AssignmentListener to register<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> void registerListener(ProcedureStoreListener listener);<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> * Remove the listener from the notification list.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @param listener The AssignmentListener to unregister<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.111"></a> -<span class="sourceLineNo">112</span> */<a name="line.112"></a> -<span class="sourceLineNo">113</span> boolean unregisterListener(ProcedureStoreListener listener);<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> * Start/Open the procedure store<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param numThreads<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> void start(int numThreads) throws IOException;<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> * Stop/Close the procedure store<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @param abort true if the stop is an abort<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> void stop(boolean abort);<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @return true if the store is running, otherwise false.<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> boolean isRunning();<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @return the number of threads/slots passed to start()<a name="line.133"></a> +<span class="sourceLineNo">088</span> * @return the next procedure in the iteration as ProcedureInfo.<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> ProcedureInfo nextAsProcedureInfo();<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> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> public interface ProcedureLoader {<a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @param maxProcId the highest proc-id in the store<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void setMaxProcId(long maxProcId);<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> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> void load(ProcedureIterator procIter) throws IOException;<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> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.111"></a> +<span class="sourceLineNo">112</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Add the listener to the notification list.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param listener The AssignmentListener to register<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> void registerListener(ProcedureStoreListener listener);<a name="line.122"></a> +<span class="sourceLineNo">123</span><a name="line.123"></a> +<span class="sourceLineNo">124</span> /**<a name="line.124"></a> +<span class="sourceLineNo">125</span> * Remove the listener from the notification list.<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param listener The AssignmentListener to unregister<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> boolean unregisterListener(ProcedureStoreListener listener);<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> * Start/Open the procedure store<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param numThreads<a name="line.133"></a> <span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> int getNumThreads();<a name="line.135"></a> +<span class="sourceLineNo">135</span> void start(int numThreads) throws IOException;<a name="line.135"></a> <span class="sourceLineNo">136</span><a name="line.136"></a> <span class="sourceLineNo">137</span> /**<a name="line.137"></a> -<span class="sourceLineNo">138</span> * Acquire the lease for the procedure store.<a name="line.138"></a> -<span class="sourceLineNo">139</span> */<a name="line.139"></a> -<span class="sourceLineNo">140</span> void recoverLease() throws IOException;<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> * Load the Procedures in the store.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.144"></a> +<span class="sourceLineNo">138</span> * Stop/Close the procedure store<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param abort true if the stop is an abort<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> void stop(boolean abort);<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> * @return true if the store is running, otherwise false.<a name="line.144"></a> <span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> void load(ProcedureLoader loader) throws IOException;<a name="line.146"></a> +<span class="sourceLineNo">146</span> boolean isRunning();<a name="line.146"></a> <span class="sourceLineNo">147</span><a name="line.147"></a> <span class="sourceLineNo">148</span> /**<a name="line.148"></a> -<span class="sourceLineNo">149</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.154"></a> -<span class="sourceLineNo">155</span> *<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @param proc the procedure to serialize and write to the store.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param subprocs the newly created child of the proc.<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> void insert(Procedure proc, Procedure[] subprocs);<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * The specified procedure was executed,<a name="line.162"></a> -<span class="sourceLineNo">163</span> * and the new state should be written to the store.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @param proc the procedure to serialize and write to the store.<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> void update(Procedure proc);<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> * The specified procId was removed from the executor,<a name="line.169"></a> -<span class="sourceLineNo">170</span> * due to completion, abort or failure.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * The store implementor should remove all the information about the specified procId.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @param procId the ID of the procedure to remove.<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> void delete(long procId);<a name="line.174"></a> -<span class="sourceLineNo">175</span>}<a name="line.175"></a> +<span class="sourceLineNo">149</span> * @return the number of threads/slots passed to start()<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> int getNumThreads();<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> * Acquire the lease for the procedure store.<a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span> void recoverLease() throws IOException;<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> * Load the Procedures in the store.<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.160"></a> +<span class="sourceLineNo">161</span> */<a name="line.161"></a> +<span class="sourceLineNo">162</span> void load(ProcedureLoader loader) throws IOException;<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.170"></a> +<span class="sourceLineNo">171</span> *<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param proc the procedure to serialize and write to the store.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param subprocs the newly created child of the proc.<a name="line.173"></a> +<span class="sourceLineNo">174</span> */<a name="line.174"></a> +<span class="sourceLineNo">175</span> void insert(Procedure proc, Procedure[] subprocs);<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> * The specified procedure was executed,<a name="line.178"></a> +<span class="sourceLineNo">179</span> * and the new state should be written to the store.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @param proc the procedure to serialize and write to the store.<a name="line.180"></a> +<span class="sourceLineNo">181</span> */<a name="line.181"></a> +<span class="sourceLineNo">182</span> void update(Procedure proc);<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> /**<a name="line.184"></a> +<span class="sourceLineNo">185</span> * The specified procId was removed from the executor,<a name="line.185"></a> +<span class="sourceLineNo">186</span> * due to completion, abort or failure.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * The store implementor should remove all the information about the specified procId.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param procId the ID of the procedure to remove.<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> void delete(long procId);<a name="line.190"></a> +<span class="sourceLineNo">191</span>}<a name="line.191"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f8d6f420/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html index 748314e..6dcf0c1 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureLoader.html @@ -30,157 +30,173 @@ <span class="sourceLineNo">022</span><a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.procedure2.Procedure;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>/**<a name="line.27"></a> -<span class="sourceLineNo">028</span> * The ProcedureStore is used by the executor to persist the state of each procedure execution.<a name="line.28"></a> -<span class="sourceLineNo">029</span> * This allows to resume the execution of pending/in-progress procedures in case<a name="line.29"></a> -<span class="sourceLineNo">030</span> * of machine failure or service shutdown.<a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceStability.Evolving<a name="line.33"></a> -<span class="sourceLineNo">034</span>public interface ProcedureStore {<a name="line.34"></a> -<span class="sourceLineNo">035</span> /**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Store listener interface.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * The main process should register a listener and respond to the store events.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> public interface ProcedureStoreListener {<a name="line.39"></a> -<span class="sourceLineNo">040</span> /**<a name="line.40"></a> -<span class="sourceLineNo">041</span> * triggered when the store sync is completed.<a name="line.41"></a> -<span class="sourceLineNo">042</span> */<a name="line.42"></a> -<span class="sourceLineNo">043</span> void postSync();<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * triggered when the store is not able to write out data.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * the main process should abort.<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> void abortProcess();<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> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * An Iterator over a collection of Procedure<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> public interface ProcedureIterator {<a name="line.55"></a> -<span class="sourceLineNo">056</span> /**<a name="line.56"></a> -<span class="sourceLineNo">057</span> * Reset the Iterator by seeking to the beginning of the list.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> void reset();<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> /**<a name="line.61"></a> -<span class="sourceLineNo">062</span> * Returns true if the iterator has more elements.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * (In other words, returns true if next() would return a Procedure<a name="line.63"></a> -<span class="sourceLineNo">064</span> * rather than throwing an exception.)<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @return true if the iterator has more procedures<a name="line.65"></a> -<span class="sourceLineNo">066</span> */<a name="line.66"></a> -<span class="sourceLineNo">067</span> boolean hasNext();<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> * Returns the next procedure in the iteration.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @return the next procedure in the iteration.<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> Procedure next() throws IOException;<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> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> public interface ProcedureLoader {<a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param maxProcId the highest proc-id in the store<a name="line.83"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.ProcedureInfo;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.procedure2.Procedure;<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> * The ProcedureStore is used by the executor to persist the state of each procedure execution.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * This allows to resume the execution of pending/in-progress procedures in case<a name="line.30"></a> +<span class="sourceLineNo">031</span> * of machine failure or service shutdown.<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> +<span class="sourceLineNo">034</span>@InterfaceStability.Evolving<a name="line.34"></a> +<span class="sourceLineNo">035</span>public interface ProcedureStore {<a name="line.35"></a> +<span class="sourceLineNo">036</span> /**<a name="line.36"></a> +<span class="sourceLineNo">037</span> * Store listener interface.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * The main process should register a listener and respond to the store events.<a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span> public interface ProcedureStoreListener {<a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * triggered when the store sync is completed.<a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> void postSync();<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> * triggered when the store is not able to write out data.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * the main process should abort.<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> void abortProcess();<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<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> * An Iterator over a collection of Procedure<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public interface ProcedureIterator {<a name="line.56"></a> +<span class="sourceLineNo">057</span> /**<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Reset the Iterator by seeking to the beginning of the list.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> void reset();<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> /**<a name="line.62"></a> +<span class="sourceLineNo">063</span> * Returns true if the iterator has more elements.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * (In other words, returns true if next() would return a Procedure<a name="line.64"></a> +<span class="sourceLineNo">065</span> * rather than throwing an exception.)<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @return true if the iterator has more procedures<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> boolean hasNext();<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @return true if the iterator next element is a completed procedure.<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> boolean isNextCompleted();<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> * Skip the next procedure<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> void skipNext();<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Returns the next procedure in the iteration.<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return the next procedure in the iteration.<a name="line.83"></a> <span class="sourceLineNo">084</span> */<a name="line.84"></a> -<span class="sourceLineNo">085</span> void setMaxProcId(long maxProcId);<a name="line.85"></a> +<span class="sourceLineNo">085</span> Procedure nextAsProcedure() throws IOException;<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> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.88"></a> -<span class="sourceLineNo">089</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.90"></a> -<span class="sourceLineNo">091</span> */<a name="line.91"></a> -<span class="sourceLineNo">092</span> void load(ProcedureIterator procIter) throws IOException;<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> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.95"></a> -<span class="sourceLineNo">096</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.96"></a> -<span class="sourceLineNo">097</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.97"></a> -<span class="sourceLineNo">098</span> */<a name="line.98"></a> -<span class="sourceLineNo">099</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.99"></a> -<span class="sourceLineNo">100</span> }<a name="line.100"></a> -<span class="sourceLineNo">101</span><a name="line.101"></a> -<span class="sourceLineNo">102</span> /**<a name="line.102"></a> -<span class="sourceLineNo">103</span> * Add the listener to the notification list.<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @param listener The AssignmentListener to register<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> void registerListener(ProcedureStoreListener listener);<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> * Remove the listener from the notification list.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @param listener The AssignmentListener to unregister<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.111"></a> -<span class="sourceLineNo">112</span> */<a name="line.112"></a> -<span class="sourceLineNo">113</span> boolean unregisterListener(ProcedureStoreListener listener);<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> * Start/Open the procedure store<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param numThreads<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> void start(int numThreads) throws IOException;<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> * Stop/Close the procedure store<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @param abort true if the stop is an abort<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> void stop(boolean abort);<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @return true if the store is running, otherwise false.<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> boolean isRunning();<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @return the number of threads/slots passed to start()<a name="line.133"></a> +<span class="sourceLineNo">088</span> * @return the next procedure in the iteration as ProcedureInfo.<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> ProcedureInfo nextAsProcedureInfo();<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> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> public interface ProcedureLoader {<a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @param maxProcId the highest proc-id in the store<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void setMaxProcId(long maxProcId);<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> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> void load(ProcedureIterator procIter) throws IOException;<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> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.111"></a> +<span class="sourceLineNo">112</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Add the listener to the notification list.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param listener The AssignmentListener to register<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> void registerListener(ProcedureStoreListener listener);<a name="line.122"></a> +<span class="sourceLineNo">123</span><a name="line.123"></a> +<span class="sourceLineNo">124</span> /**<a name="line.124"></a> +<span class="sourceLineNo">125</span> * Remove the listener from the notification list.<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param listener The AssignmentListener to unregister<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> boolean unregisterListener(ProcedureStoreListener listener);<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> * Start/Open the procedure store<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param numThreads<a name="line.133"></a> <span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> int getNumThreads();<a name="line.135"></a> +<span class="sourceLineNo">135</span> void start(int numThreads) throws IOException;<a name="line.135"></a> <span class="sourceLineNo">136</span><a name="line.136"></a> <span class="sourceLineNo">137</span> /**<a name="line.137"></a> -<span class="sourceLineNo">138</span> * Acquire the lease for the procedure store.<a name="line.138"></a> -<span class="sourceLineNo">139</span> */<a name="line.139"></a> -<span class="sourceLineNo">140</span> void recoverLease() throws IOException;<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> * Load the Procedures in the store.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.144"></a> +<span class="sourceLineNo">138</span> * Stop/Close the procedure store<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param abort true if the stop is an abort<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> void stop(boolean abort);<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> * @return true if the store is running, otherwise false.<a name="line.144"></a> <span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> void load(ProcedureLoader loader) throws IOException;<a name="line.146"></a> +<span class="sourceLineNo">146</span> boolean isRunning();<a name="line.146"></a> <span class="sourceLineNo">147</span><a name="line.147"></a> <span class="sourceLineNo">148</span> /**<a name="line.148"></a> -<span class="sourceLineNo">149</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.154"></a> -<span class="sourceLineNo">155</span> *<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @param proc the procedure to serialize and write to the store.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param subprocs the newly created child of the proc.<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> void insert(Procedure proc, Procedure[] subprocs);<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * The specified procedure was executed,<a name="line.162"></a> -<span class="sourceLineNo">163</span> * and the new state should be written to the store.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @param proc the procedure to serialize and write to the store.<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> void update(Procedure proc);<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> * The specified procId was removed from the executor,<a name="line.169"></a> -<span class="sourceLineNo">170</span> * due to completion, abort or failure.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * The store implementor should remove all the information about the specified procId.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @param procId the ID of the procedure to remove.<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> void delete(long procId);<a name="line.174"></a> -<span class="sourceLineNo">175</span>}<a name="line.175"></a> +<span class="sourceLineNo">149</span> * @return the number of threads/slots passed to start()<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> int getNumThreads();<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> * Acquire the lease for the procedure store.<a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span> void recoverLease() throws IOException;<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> * Load the Procedures in the store.<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.160"></a> +<span class="sourceLineNo">161</span> */<a name="line.161"></a> +<span class="sourceLineNo">162</span> void load(ProcedureLoader loader) throws IOException;<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.170"></a> +<span class="sourceLineNo">171</span> *<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param proc the procedure to serialize and write to the store.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param subprocs the newly created child of the proc.<a name="line.173"></a> +<span class="sourceLineNo">174</span> */<a name="line.174"></a> +<span class="sourceLineNo">175</span> void insert(Procedure proc, Procedure[] subprocs);<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> * The specified procedure was executed,<a name="line.178"></a> +<span class="sourceLineNo">179</span> * and the new state should be written to the store.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @param proc the procedure to serialize and write to the store.<a name="line.180"></a> +<span class="sourceLineNo">181</span> */<a name="line.181"></a> +<span class="sourceLineNo">182</span> void update(Procedure proc);<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> /**<a name="line.184"></a> +<span class="sourceLineNo">185</span> * The specified procId was removed from the executor,<a name="line.185"></a> +<span class="sourceLineNo">186</span> * due to completion, abort or failure.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * The store implementor should remove all the information about the specified procId.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param procId the ID of the procedure to remove.<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> void delete(long procId);<a name="line.190"></a> +<span class="sourceLineNo">191</span>}<a name="line.191"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f8d6f420/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html index 748314e..6dcf0c1 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/store/ProcedureStore.ProcedureStoreListener.html @@ -30,157 +30,173 @@ <span class="sourceLineNo">022</span><a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.procedure2.Procedure;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>/**<a name="line.27"></a> -<span class="sourceLineNo">028</span> * The ProcedureStore is used by the executor to persist the state of each procedure execution.<a name="line.28"></a> -<span class="sourceLineNo">029</span> * This allows to resume the execution of pending/in-progress procedures in case<a name="line.29"></a> -<span class="sourceLineNo">030</span> * of machine failure or service shutdown.<a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceStability.Evolving<a name="line.33"></a> -<span class="sourceLineNo">034</span>public interface ProcedureStore {<a name="line.34"></a> -<span class="sourceLineNo">035</span> /**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Store listener interface.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * The main process should register a listener and respond to the store events.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> public interface ProcedureStoreListener {<a name="line.39"></a> -<span class="sourceLineNo">040</span> /**<a name="line.40"></a> -<span class="sourceLineNo">041</span> * triggered when the store sync is completed.<a name="line.41"></a> -<span class="sourceLineNo">042</span> */<a name="line.42"></a> -<span class="sourceLineNo">043</span> void postSync();<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * triggered when the store is not able to write out data.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * the main process should abort.<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> void abortProcess();<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> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * An Iterator over a collection of Procedure<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> public interface ProcedureIterator {<a name="line.55"></a> -<span class="sourceLineNo">056</span> /**<a name="line.56"></a> -<span class="sourceLineNo">057</span> * Reset the Iterator by seeking to the beginning of the list.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> void reset();<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> /**<a name="line.61"></a> -<span class="sourceLineNo">062</span> * Returns true if the iterator has more elements.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * (In other words, returns true if next() would return a Procedure<a name="line.63"></a> -<span class="sourceLineNo">064</span> * rather than throwing an exception.)<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @return true if the iterator has more procedures<a name="line.65"></a> -<span class="sourceLineNo">066</span> */<a name="line.66"></a> -<span class="sourceLineNo">067</span> boolean hasNext();<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> * Returns the next procedure in the iteration.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @return the next procedure in the iteration.<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> Procedure next() throws IOException;<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> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> public interface ProcedureLoader {<a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param maxProcId the highest proc-id in the store<a name="line.83"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.ProcedureInfo;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.procedure2.Procedure;<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> * The ProcedureStore is used by the executor to persist the state of each procedure execution.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * This allows to resume the execution of pending/in-progress procedures in case<a name="line.30"></a> +<span class="sourceLineNo">031</span> * of machine failure or service shutdown.<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> +<span class="sourceLineNo">034</span>@InterfaceStability.Evolving<a name="line.34"></a> +<span class="sourceLineNo">035</span>public interface ProcedureStore {<a name="line.35"></a> +<span class="sourceLineNo">036</span> /**<a name="line.36"></a> +<span class="sourceLineNo">037</span> * Store listener interface.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * The main process should register a listener and respond to the store events.<a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span> public interface ProcedureStoreListener {<a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * triggered when the store sync is completed.<a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> void postSync();<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> * triggered when the store is not able to write out data.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * the main process should abort.<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> void abortProcess();<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<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> * An Iterator over a collection of Procedure<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public interface ProcedureIterator {<a name="line.56"></a> +<span class="sourceLineNo">057</span> /**<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Reset the Iterator by seeking to the beginning of the list.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> void reset();<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> /**<a name="line.62"></a> +<span class="sourceLineNo">063</span> * Returns true if the iterator has more elements.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * (In other words, returns true if next() would return a Procedure<a name="line.64"></a> +<span class="sourceLineNo">065</span> * rather than throwing an exception.)<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @return true if the iterator has more procedures<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> boolean hasNext();<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @return true if the iterator next element is a completed procedure.<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> boolean isNextCompleted();<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> * Skip the next procedure<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> void skipNext();<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Returns the next procedure in the iteration.<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @throws IOException if there was an error fetching/deserializing the procedure<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return the next procedure in the iteration.<a name="line.83"></a> <span class="sourceLineNo">084</span> */<a name="line.84"></a> -<span class="sourceLineNo">085</span> void setMaxProcId(long maxProcId);<a name="line.85"></a> +<span class="sourceLineNo">085</span> Procedure nextAsProcedure() throws IOException;<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> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.88"></a> -<span class="sourceLineNo">089</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.90"></a> -<span class="sourceLineNo">091</span> */<a name="line.91"></a> -<span class="sourceLineNo">092</span> void load(ProcedureIterator procIter) throws IOException;<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> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.95"></a> -<span class="sourceLineNo">096</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.96"></a> -<span class="sourceLineNo">097</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.97"></a> -<span class="sourceLineNo">098</span> */<a name="line.98"></a> -<span class="sourceLineNo">099</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.99"></a> -<span class="sourceLineNo">100</span> }<a name="line.100"></a> -<span class="sourceLineNo">101</span><a name="line.101"></a> -<span class="sourceLineNo">102</span> /**<a name="line.102"></a> -<span class="sourceLineNo">103</span> * Add the listener to the notification list.<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @param listener The AssignmentListener to register<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> void registerListener(ProcedureStoreListener listener);<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> * Remove the listener from the notification list.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @param listener The AssignmentListener to unregister<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.111"></a> -<span class="sourceLineNo">112</span> */<a name="line.112"></a> -<span class="sourceLineNo">113</span> boolean unregisterListener(ProcedureStoreListener listener);<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> * Start/Open the procedure store<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param numThreads<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> void start(int numThreads) throws IOException;<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> * Stop/Close the procedure store<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @param abort true if the stop is an abort<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> void stop(boolean abort);<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @return true if the store is running, otherwise false.<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> boolean isRunning();<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @return the number of threads/slots passed to start()<a name="line.133"></a> +<span class="sourceLineNo">088</span> * @return the next procedure in the iteration as ProcedureInfo.<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> ProcedureInfo nextAsProcedureInfo();<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> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Interface passed to the ProcedureStore.load() method to handle the store-load events.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> public interface ProcedureLoader {<a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Called by ProcedureStore.load() to notify about the maximum proc-id in the store.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @param maxProcId the highest proc-id in the store<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void setMaxProcId(long maxProcId);<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> * Called by the ProcedureStore.load() every time a set of procedures are ready to be executed.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * The ProcedureIterator passed to the method, has the procedure sorted in replay-order.<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @param procIter iterator over the procedures ready to be added to the executor.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> void load(ProcedureIterator procIter) throws IOException;<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> * Called by the ProcedureStore.load() in case we have procedures not-ready to be added to<a name="line.111"></a> +<span class="sourceLineNo">112</span> * the executor, which probably means they are corrupted since some information/link is missing.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @param procIter iterator over the procedures not ready to be added to the executor, corrupted<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> void handleCorrupted(ProcedureIterator procIter) throws IOException;<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Add the listener to the notification list.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param listener The AssignmentListener to register<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> void registerListener(ProcedureStoreListener listener);<a name="line.122"></a> +<span class="sourceLineNo">123</span><a name="line.123"></a> +<span class="sourceLineNo">124</span> /**<a name="line.124"></a> +<span class="sourceLineNo">125</span> * Remove the listener from the notification list.<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param listener The AssignmentListener to unregister<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return true if the listner was in the list and it was removed, otherwise false.<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> boolean unregisterListener(ProcedureStoreListener listener);<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> * Start/Open the procedure store<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param numThreads<a name="line.133"></a> <span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> int getNumThreads();<a name="line.135"></a> +<span class="sourceLineNo">135</span> void start(int numThreads) throws IOException;<a name="line.135"></a> <span class="sourceLineNo">136</span><a name="line.136"></a> <span class="sourceLineNo">137</span> /**<a name="line.137"></a> -<span class="sourceLineNo">138</span> * Acquire the lease for the procedure store.<a name="line.138"></a> -<span class="sourceLineNo">139</span> */<a name="line.139"></a> -<span class="sourceLineNo">140</span> void recoverLease() throws IOException;<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> * Load the Procedures in the store.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.144"></a> +<span class="sourceLineNo">138</span> * Stop/Close the procedure store<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param abort true if the stop is an abort<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> void stop(boolean abort);<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> * @return true if the store is running, otherwise false.<a name="line.144"></a> <span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> void load(ProcedureLoader loader) throws IOException;<a name="line.146"></a> +<span class="sourceLineNo">146</span> boolean isRunning();<a name="line.146"></a> <span class="sourceLineNo">147</span><a name="line.147"></a> <span class="sourceLineNo">148</span> /**<a name="line.148"></a> -<span class="sourceLineNo">149</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.154"></a> -<span class="sourceLineNo">155</span> *<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @param proc the procedure to serialize and write to the store.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param subprocs the newly created child of the proc.<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> void insert(Procedure proc, Procedure[] subprocs);<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * The specified procedure was executed,<a name="line.162"></a> -<span class="sourceLineNo">163</span> * and the new state should be written to the store.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @param proc the procedure to serialize and write to the store.<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> void update(Procedure proc);<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> * The specified procId was removed from the executor,<a name="line.169"></a> -<span class="sourceLineNo">170</span> * due to completion, abort or failure.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * The store implementor should remove all the information about the specified procId.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @param procId the ID of the procedure to remove.<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> void delete(long procId);<a name="line.174"></a> -<span class="sourceLineNo">175</span>}<a name="line.175"></a> +<span class="sourceLineNo">149</span> * @return the number of threads/slots passed to start()<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> int getNumThreads();<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> * Acquire the lease for the procedure store.<a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span> void recoverLease() throws IOException;<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> * Load the Procedures in the store.<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param loader the ProcedureLoader that will handle the store-load events<a name="line.160"></a> +<span class="sourceLineNo">161</span> */<a name="line.161"></a> +<span class="sourceLineNo">162</span> void load(ProcedureLoader loader) throws IOException;<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * When a procedure is submitted to the executor insert(proc, null) will be called.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * 'proc' has a 'RUNNABLE' state and the initial information required to start up.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * When a procedure is executed and it returns children insert(proc, subprocs) will be called.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * 'proc' has a 'WAITING' state and an update state.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * 'subprocs' are the children in 'RUNNABLE' state with the initial information.<a name="line.170"></a> +<span class="sourceLineNo">171</span> *<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param proc the procedure to serialize and write to the store.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param subprocs the newly created child of the proc.<a name="line.173"></a> +<span class="sourceLineNo">174</span> */<a name="line.174"></a> +<span class="sourceLineNo">175</span> void insert(Procedure proc, Procedure[] subprocs);<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> * The specified procedure was executed,<a name="line.178"></a> +<span class="sourceLineNo">179</span> * and the new state should be written to the store.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @param proc the procedure to serialize and write to the store.<a name="line.180"></a> +<span class="sourceLineNo">181</span> */<a name="line.181"></a> +<span class="sourceLineNo">182</span> void update(Procedure proc);<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> /**<a name="line.184"></a> +<span class="sourceLineNo">185</span> * The specified procId was removed from the executor,<a name="line.185"></a> +<span class="sourceLineNo">186</span> * due to completion, abort or failure.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * The store implementor should remove all the information about the specified procId.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param procId the ID of the procedure to remove.<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> void delete(long procId);<a name="line.190"></a> +<span class="sourceLineNo">191</span>}<a name="line.191"></a>