http://git-wip-us.apache.org/repos/asf/hbase-site/blob/47be635d/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html index 6ecabed..59c2836 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html @@ -25,108 +25,116 @@ <span class="sourceLineNo">017</span> */<a name="line.17"></a> <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.client.Result;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>/**<a name="line.24"></a> -<span class="sourceLineNo">025</span> * Receives {@link Result} for an asynchronous scan.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.27"></a> -<span class="sourceLineNo">028</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.28"></a> -<span class="sourceLineNo">029</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.29"></a> -<span class="sourceLineNo">030</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.30"></a> -<span class="sourceLineNo">031</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceAudience.Public<a name="line.33"></a> -<span class="sourceLineNo">034</span>public interface RawScanResultConsumer {<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> /**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Used to resume a scan.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> @InterfaceAudience.Public<a name="line.39"></a> -<span class="sourceLineNo">040</span> interface ScanResumer {<a name="line.40"></a> -<span class="sourceLineNo">041</span><a name="line.41"></a> -<span class="sourceLineNo">042</span> /**<a name="line.42"></a> -<span class="sourceLineNo">043</span> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.43"></a> -<span class="sourceLineNo">044</span> * effect.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> void resume();<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> /**<a name="line.49"></a> -<span class="sourceLineNo">050</span> * Used to suspend or stop a scan.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> -<span class="sourceLineNo">052</span> * Notice that, you should only call the methods below inside onNext or onHeartbeat method. A<a name="line.52"></a> -<span class="sourceLineNo">053</span> * IllegalStateException will be thrown if you call them at other places.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> -<span class="sourceLineNo">055</span> * You can only call one of the methods below, i.e., call suspend or terminate(of course you are<a name="line.55"></a> -<span class="sourceLineNo">056</span> * free to not call them both), and the methods are not reentrant. A IllegalStateException will be<a name="line.56"></a> -<span class="sourceLineNo">057</span> * thrown if you have already called one of the methods.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> @InterfaceAudience.Public<a name="line.59"></a> -<span class="sourceLineNo">060</span> interface ScanController {<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> * Suspend the scan.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> -<span class="sourceLineNo">065</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.65"></a> -<span class="sourceLineNo">066</span> * before you resume the scan.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @return A resumer used to resume the scan later.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> ScanResumer suspend();<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * Terminate the scan.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.74"></a> -<span class="sourceLineNo">075</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> void terminate();<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> /**<a name="line.80"></a> -<span class="sourceLineNo">081</span> * Indicate that we have receive some data.<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param results the data fetched from HBase service.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.83"></a> -<span class="sourceLineNo">084</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.84"></a> -<span class="sourceLineNo">085</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> void onNext(Result[] results, ScanController controller);<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.90"></a> -<span class="sourceLineNo">091</span> * onNext.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> -<span class="sourceLineNo">093</span> * This method give you a chance to terminate a slow scan operation.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.94"></a> -<span class="sourceLineNo">095</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.95"></a> -<span class="sourceLineNo">096</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.96"></a> -<span class="sourceLineNo">097</span> */<a name="line.97"></a> -<span class="sourceLineNo">098</span> default void onHeartbeat(ScanController controller) {<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<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> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * <p><a name="line.103"></a> -<span class="sourceLineNo">104</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.104"></a> +<span class="sourceLineNo">020</span>import java.util.Optional;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.Result;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>/**<a name="line.26"></a> +<span class="sourceLineNo">027</span> * Receives {@link Result} for an asynchronous scan.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.29"></a> +<span class="sourceLineNo">030</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.30"></a> +<span class="sourceLineNo">031</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.31"></a> +<span class="sourceLineNo">032</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.32"></a> +<span class="sourceLineNo">033</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.33"></a> +<span class="sourceLineNo">034</span> */<a name="line.34"></a> +<span class="sourceLineNo">035</span>@InterfaceAudience.Public<a name="line.35"></a> +<span class="sourceLineNo">036</span>public interface RawScanResultConsumer {<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Used to resume a scan.<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> @InterfaceAudience.Public<a name="line.41"></a> +<span class="sourceLineNo">042</span> interface ScanResumer {<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> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.45"></a> +<span class="sourceLineNo">046</span> * effect.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> void resume();<a name="line.48"></a> +<span class="sourceLineNo">049</span> }<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> * Used to suspend or stop a scan, or get a scan cursor if available.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * Notice that, you should only call the {@link #suspend()} or {@link #terminate()} inside onNext<a name="line.54"></a> +<span class="sourceLineNo">055</span> * or onHeartbeat method. A IllegalStateException will be thrown if you call them at other places.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * You can only call one of the {@link #suspend()} and {@link #terminate()} methods(of course you<a name="line.57"></a> +<span class="sourceLineNo">058</span> * are free to not call them both), and the methods are not reentrant. An IllegalStateException<a name="line.58"></a> +<span class="sourceLineNo">059</span> * will be thrown if you have already called one of the methods.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> @InterfaceAudience.Public<a name="line.61"></a> +<span class="sourceLineNo">062</span> interface ScanController {<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> * Suspend the scan.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p><a name="line.66"></a> +<span class="sourceLineNo">067</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.67"></a> +<span class="sourceLineNo">068</span> * before you resume the scan.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @return A resumer used to resume the scan later.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> ScanResumer suspend();<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> * Terminate the scan.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * <p><a name="line.75"></a> +<span class="sourceLineNo">076</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.76"></a> +<span class="sourceLineNo">077</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.77"></a> +<span class="sourceLineNo">078</span> */<a name="line.78"></a> +<span class="sourceLineNo">079</span> void terminate();<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> /**<a name="line.81"></a> +<span class="sourceLineNo">082</span> * Get the scan cursor if available.<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The scan cursor.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> Optional<Cursor> cursor();<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> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * Indicate that we have receive some data.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @param results the data fetched from HBase service.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.91"></a> +<span class="sourceLineNo">092</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.92"></a> +<span class="sourceLineNo">093</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> void onNext(Result[] results, ScanController controller);<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> +<span class="sourceLineNo">099</span> * onNext.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <p><a name="line.100"></a> +<span class="sourceLineNo">101</span> * This method give you a chance to terminate a slow scan operation.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.102"></a> +<span class="sourceLineNo">103</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.103"></a> +<span class="sourceLineNo">104</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.104"></a> <span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> void onError(Throwable error);<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> * Indicate that the scan operation is completed normally.<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> void onComplete();<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> /**<a name="line.113"></a> -<span class="sourceLineNo">114</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.114"></a> -<span class="sourceLineNo">115</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.115"></a> -<span class="sourceLineNo">116</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.116"></a> -<span class="sourceLineNo">117</span> * store it somewhere to get the metrics at any time if you want.<a name="line.117"></a> +<span class="sourceLineNo">106</span> default void onHeartbeat(ScanController controller) {<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<a name="line.107"></a> +<span class="sourceLineNo">108</span><a name="line.108"></a> +<span class="sourceLineNo">109</span> /**<a name="line.109"></a> +<span class="sourceLineNo">110</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> +<span class="sourceLineNo">112</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.112"></a> +<span class="sourceLineNo">113</span> */<a name="line.113"></a> +<span class="sourceLineNo">114</span> void onError(Throwable error);<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * Indicate that the scan operation is completed normally.<a name="line.117"></a> <span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<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">119</span> void onComplete();<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> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.122"></a> +<span class="sourceLineNo">123</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.123"></a> +<span class="sourceLineNo">124</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.124"></a> +<span class="sourceLineNo">125</span> * store it somewhere to get the metrics at any time if you want.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span>}<a name="line.129"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/47be635d/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html index 6ecabed..59c2836 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html @@ -25,108 +25,116 @@ <span class="sourceLineNo">017</span> */<a name="line.17"></a> <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.client.Result;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>/**<a name="line.24"></a> -<span class="sourceLineNo">025</span> * Receives {@link Result} for an asynchronous scan.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.27"></a> -<span class="sourceLineNo">028</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.28"></a> -<span class="sourceLineNo">029</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.29"></a> -<span class="sourceLineNo">030</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.30"></a> -<span class="sourceLineNo">031</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceAudience.Public<a name="line.33"></a> -<span class="sourceLineNo">034</span>public interface RawScanResultConsumer {<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> /**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Used to resume a scan.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> @InterfaceAudience.Public<a name="line.39"></a> -<span class="sourceLineNo">040</span> interface ScanResumer {<a name="line.40"></a> -<span class="sourceLineNo">041</span><a name="line.41"></a> -<span class="sourceLineNo">042</span> /**<a name="line.42"></a> -<span class="sourceLineNo">043</span> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.43"></a> -<span class="sourceLineNo">044</span> * effect.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> void resume();<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> /**<a name="line.49"></a> -<span class="sourceLineNo">050</span> * Used to suspend or stop a scan.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> -<span class="sourceLineNo">052</span> * Notice that, you should only call the methods below inside onNext or onHeartbeat method. A<a name="line.52"></a> -<span class="sourceLineNo">053</span> * IllegalStateException will be thrown if you call them at other places.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> -<span class="sourceLineNo">055</span> * You can only call one of the methods below, i.e., call suspend or terminate(of course you are<a name="line.55"></a> -<span class="sourceLineNo">056</span> * free to not call them both), and the methods are not reentrant. A IllegalStateException will be<a name="line.56"></a> -<span class="sourceLineNo">057</span> * thrown if you have already called one of the methods.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> @InterfaceAudience.Public<a name="line.59"></a> -<span class="sourceLineNo">060</span> interface ScanController {<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> * Suspend the scan.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> -<span class="sourceLineNo">065</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.65"></a> -<span class="sourceLineNo">066</span> * before you resume the scan.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @return A resumer used to resume the scan later.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> ScanResumer suspend();<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * Terminate the scan.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.74"></a> -<span class="sourceLineNo">075</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> void terminate();<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> /**<a name="line.80"></a> -<span class="sourceLineNo">081</span> * Indicate that we have receive some data.<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param results the data fetched from HBase service.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.83"></a> -<span class="sourceLineNo">084</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.84"></a> -<span class="sourceLineNo">085</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> void onNext(Result[] results, ScanController controller);<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.90"></a> -<span class="sourceLineNo">091</span> * onNext.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> -<span class="sourceLineNo">093</span> * This method give you a chance to terminate a slow scan operation.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.94"></a> -<span class="sourceLineNo">095</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.95"></a> -<span class="sourceLineNo">096</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.96"></a> -<span class="sourceLineNo">097</span> */<a name="line.97"></a> -<span class="sourceLineNo">098</span> default void onHeartbeat(ScanController controller) {<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<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> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * <p><a name="line.103"></a> -<span class="sourceLineNo">104</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.104"></a> +<span class="sourceLineNo">020</span>import java.util.Optional;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.Result;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>/**<a name="line.26"></a> +<span class="sourceLineNo">027</span> * Receives {@link Result} for an asynchronous scan.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.29"></a> +<span class="sourceLineNo">030</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.30"></a> +<span class="sourceLineNo">031</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.31"></a> +<span class="sourceLineNo">032</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.32"></a> +<span class="sourceLineNo">033</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.33"></a> +<span class="sourceLineNo">034</span> */<a name="line.34"></a> +<span class="sourceLineNo">035</span>@InterfaceAudience.Public<a name="line.35"></a> +<span class="sourceLineNo">036</span>public interface RawScanResultConsumer {<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Used to resume a scan.<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> @InterfaceAudience.Public<a name="line.41"></a> +<span class="sourceLineNo">042</span> interface ScanResumer {<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> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.45"></a> +<span class="sourceLineNo">046</span> * effect.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> void resume();<a name="line.48"></a> +<span class="sourceLineNo">049</span> }<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> * Used to suspend or stop a scan, or get a scan cursor if available.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * Notice that, you should only call the {@link #suspend()} or {@link #terminate()} inside onNext<a name="line.54"></a> +<span class="sourceLineNo">055</span> * or onHeartbeat method. A IllegalStateException will be thrown if you call them at other places.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * You can only call one of the {@link #suspend()} and {@link #terminate()} methods(of course you<a name="line.57"></a> +<span class="sourceLineNo">058</span> * are free to not call them both), and the methods are not reentrant. An IllegalStateException<a name="line.58"></a> +<span class="sourceLineNo">059</span> * will be thrown if you have already called one of the methods.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> @InterfaceAudience.Public<a name="line.61"></a> +<span class="sourceLineNo">062</span> interface ScanController {<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> * Suspend the scan.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p><a name="line.66"></a> +<span class="sourceLineNo">067</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.67"></a> +<span class="sourceLineNo">068</span> * before you resume the scan.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @return A resumer used to resume the scan later.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> ScanResumer suspend();<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> * Terminate the scan.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * <p><a name="line.75"></a> +<span class="sourceLineNo">076</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.76"></a> +<span class="sourceLineNo">077</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.77"></a> +<span class="sourceLineNo">078</span> */<a name="line.78"></a> +<span class="sourceLineNo">079</span> void terminate();<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> /**<a name="line.81"></a> +<span class="sourceLineNo">082</span> * Get the scan cursor if available.<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The scan cursor.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> Optional<Cursor> cursor();<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> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * Indicate that we have receive some data.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @param results the data fetched from HBase service.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.91"></a> +<span class="sourceLineNo">092</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.92"></a> +<span class="sourceLineNo">093</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> void onNext(Result[] results, ScanController controller);<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> +<span class="sourceLineNo">099</span> * onNext.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <p><a name="line.100"></a> +<span class="sourceLineNo">101</span> * This method give you a chance to terminate a slow scan operation.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.102"></a> +<span class="sourceLineNo">103</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.103"></a> +<span class="sourceLineNo">104</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.104"></a> <span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> void onError(Throwable error);<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> * Indicate that the scan operation is completed normally.<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> void onComplete();<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> /**<a name="line.113"></a> -<span class="sourceLineNo">114</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.114"></a> -<span class="sourceLineNo">115</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.115"></a> -<span class="sourceLineNo">116</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.116"></a> -<span class="sourceLineNo">117</span> * store it somewhere to get the metrics at any time if you want.<a name="line.117"></a> +<span class="sourceLineNo">106</span> default void onHeartbeat(ScanController controller) {<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<a name="line.107"></a> +<span class="sourceLineNo">108</span><a name="line.108"></a> +<span class="sourceLineNo">109</span> /**<a name="line.109"></a> +<span class="sourceLineNo">110</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> +<span class="sourceLineNo">112</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.112"></a> +<span class="sourceLineNo">113</span> */<a name="line.113"></a> +<span class="sourceLineNo">114</span> void onError(Throwable error);<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * Indicate that the scan operation is completed normally.<a name="line.117"></a> <span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<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">119</span> void onComplete();<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> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.122"></a> +<span class="sourceLineNo">123</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.123"></a> +<span class="sourceLineNo">124</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.124"></a> +<span class="sourceLineNo">125</span> * store it somewhere to get the metrics at any time if you want.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span>}<a name="line.129"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/47be635d/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html index 6ecabed..59c2836 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html @@ -25,108 +25,116 @@ <span class="sourceLineNo">017</span> */<a name="line.17"></a> <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.client.Result;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>/**<a name="line.24"></a> -<span class="sourceLineNo">025</span> * Receives {@link Result} for an asynchronous scan.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.27"></a> -<span class="sourceLineNo">028</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.28"></a> -<span class="sourceLineNo">029</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.29"></a> -<span class="sourceLineNo">030</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.30"></a> -<span class="sourceLineNo">031</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceAudience.Public<a name="line.33"></a> -<span class="sourceLineNo">034</span>public interface RawScanResultConsumer {<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> /**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Used to resume a scan.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> @InterfaceAudience.Public<a name="line.39"></a> -<span class="sourceLineNo">040</span> interface ScanResumer {<a name="line.40"></a> -<span class="sourceLineNo">041</span><a name="line.41"></a> -<span class="sourceLineNo">042</span> /**<a name="line.42"></a> -<span class="sourceLineNo">043</span> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.43"></a> -<span class="sourceLineNo">044</span> * effect.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> void resume();<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> /**<a name="line.49"></a> -<span class="sourceLineNo">050</span> * Used to suspend or stop a scan.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> -<span class="sourceLineNo">052</span> * Notice that, you should only call the methods below inside onNext or onHeartbeat method. A<a name="line.52"></a> -<span class="sourceLineNo">053</span> * IllegalStateException will be thrown if you call them at other places.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> -<span class="sourceLineNo">055</span> * You can only call one of the methods below, i.e., call suspend or terminate(of course you are<a name="line.55"></a> -<span class="sourceLineNo">056</span> * free to not call them both), and the methods are not reentrant. A IllegalStateException will be<a name="line.56"></a> -<span class="sourceLineNo">057</span> * thrown if you have already called one of the methods.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> @InterfaceAudience.Public<a name="line.59"></a> -<span class="sourceLineNo">060</span> interface ScanController {<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> * Suspend the scan.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> -<span class="sourceLineNo">065</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.65"></a> -<span class="sourceLineNo">066</span> * before you resume the scan.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @return A resumer used to resume the scan later.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> ScanResumer suspend();<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * Terminate the scan.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.74"></a> -<span class="sourceLineNo">075</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> void terminate();<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> /**<a name="line.80"></a> -<span class="sourceLineNo">081</span> * Indicate that we have receive some data.<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param results the data fetched from HBase service.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.83"></a> -<span class="sourceLineNo">084</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.84"></a> -<span class="sourceLineNo">085</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> void onNext(Result[] results, ScanController controller);<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.90"></a> -<span class="sourceLineNo">091</span> * onNext.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> -<span class="sourceLineNo">093</span> * This method give you a chance to terminate a slow scan operation.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.94"></a> -<span class="sourceLineNo">095</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.95"></a> -<span class="sourceLineNo">096</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.96"></a> -<span class="sourceLineNo">097</span> */<a name="line.97"></a> -<span class="sourceLineNo">098</span> default void onHeartbeat(ScanController controller) {<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<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> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * <p><a name="line.103"></a> -<span class="sourceLineNo">104</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.104"></a> +<span class="sourceLineNo">020</span>import java.util.Optional;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.Result;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>/**<a name="line.26"></a> +<span class="sourceLineNo">027</span> * Receives {@link Result} for an asynchronous scan.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.29"></a> +<span class="sourceLineNo">030</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.30"></a> +<span class="sourceLineNo">031</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.31"></a> +<span class="sourceLineNo">032</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.32"></a> +<span class="sourceLineNo">033</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.33"></a> +<span class="sourceLineNo">034</span> */<a name="line.34"></a> +<span class="sourceLineNo">035</span>@InterfaceAudience.Public<a name="line.35"></a> +<span class="sourceLineNo">036</span>public interface RawScanResultConsumer {<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Used to resume a scan.<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> @InterfaceAudience.Public<a name="line.41"></a> +<span class="sourceLineNo">042</span> interface ScanResumer {<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> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.45"></a> +<span class="sourceLineNo">046</span> * effect.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> void resume();<a name="line.48"></a> +<span class="sourceLineNo">049</span> }<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> * Used to suspend or stop a scan, or get a scan cursor if available.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * Notice that, you should only call the {@link #suspend()} or {@link #terminate()} inside onNext<a name="line.54"></a> +<span class="sourceLineNo">055</span> * or onHeartbeat method. A IllegalStateException will be thrown if you call them at other places.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * You can only call one of the {@link #suspend()} and {@link #terminate()} methods(of course you<a name="line.57"></a> +<span class="sourceLineNo">058</span> * are free to not call them both), and the methods are not reentrant. An IllegalStateException<a name="line.58"></a> +<span class="sourceLineNo">059</span> * will be thrown if you have already called one of the methods.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> @InterfaceAudience.Public<a name="line.61"></a> +<span class="sourceLineNo">062</span> interface ScanController {<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> * Suspend the scan.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p><a name="line.66"></a> +<span class="sourceLineNo">067</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.67"></a> +<span class="sourceLineNo">068</span> * before you resume the scan.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @return A resumer used to resume the scan later.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> ScanResumer suspend();<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> * Terminate the scan.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * <p><a name="line.75"></a> +<span class="sourceLineNo">076</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.76"></a> +<span class="sourceLineNo">077</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.77"></a> +<span class="sourceLineNo">078</span> */<a name="line.78"></a> +<span class="sourceLineNo">079</span> void terminate();<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> /**<a name="line.81"></a> +<span class="sourceLineNo">082</span> * Get the scan cursor if available.<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The scan cursor.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> Optional<Cursor> cursor();<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> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * Indicate that we have receive some data.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @param results the data fetched from HBase service.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.91"></a> +<span class="sourceLineNo">092</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.92"></a> +<span class="sourceLineNo">093</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> void onNext(Result[] results, ScanController controller);<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> +<span class="sourceLineNo">099</span> * onNext.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <p><a name="line.100"></a> +<span class="sourceLineNo">101</span> * This method give you a chance to terminate a slow scan operation.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.102"></a> +<span class="sourceLineNo">103</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.103"></a> +<span class="sourceLineNo">104</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.104"></a> <span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> void onError(Throwable error);<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> * Indicate that the scan operation is completed normally.<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> void onComplete();<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> /**<a name="line.113"></a> -<span class="sourceLineNo">114</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.114"></a> -<span class="sourceLineNo">115</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.115"></a> -<span class="sourceLineNo">116</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.116"></a> -<span class="sourceLineNo">117</span> * store it somewhere to get the metrics at any time if you want.<a name="line.117"></a> +<span class="sourceLineNo">106</span> default void onHeartbeat(ScanController controller) {<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<a name="line.107"></a> +<span class="sourceLineNo">108</span><a name="line.108"></a> +<span class="sourceLineNo">109</span> /**<a name="line.109"></a> +<span class="sourceLineNo">110</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> +<span class="sourceLineNo">112</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.112"></a> +<span class="sourceLineNo">113</span> */<a name="line.113"></a> +<span class="sourceLineNo">114</span> void onError(Throwable error);<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * Indicate that the scan operation is completed normally.<a name="line.117"></a> <span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<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">119</span> void onComplete();<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> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.122"></a> +<span class="sourceLineNo">123</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.123"></a> +<span class="sourceLineNo">124</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.124"></a> +<span class="sourceLineNo">125</span> * store it somewhere to get the metrics at any time if you want.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span>}<a name="line.129"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/47be635d/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredRPCHandlerImpl.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredRPCHandlerImpl.html b/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredRPCHandlerImpl.html index 01104c2..ddb2860 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredRPCHandlerImpl.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredRPCHandlerImpl.html @@ -259,9 +259,15 @@ <span class="sourceLineNo">251</span> if (getState() != State.RUNNING) {<a name="line.251"></a> <span class="sourceLineNo">252</span> return super.toString();<a name="line.252"></a> <span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span> return super.toString() + ", rpcMethod=" + getRPC();<a name="line.254"></a> -<span class="sourceLineNo">255</span> }<a name="line.255"></a> -<span class="sourceLineNo">256</span>}<a name="line.256"></a> +<span class="sourceLineNo">254</span> return super.toString()<a name="line.254"></a> +<span class="sourceLineNo">255</span> + ", queuetimems=" + getRPCQueueTime()<a name="line.255"></a> +<span class="sourceLineNo">256</span> + ", starttimems=" + getRPCStartTime()<a name="line.256"></a> +<span class="sourceLineNo">257</span> + ", clientaddress=" + clientAddress<a name="line.257"></a> +<span class="sourceLineNo">258</span> + ", remoteport=" + remotePort<a name="line.258"></a> +<span class="sourceLineNo">259</span> + ", packetlength=" + getRPCPacketLength()<a name="line.259"></a> +<span class="sourceLineNo">260</span> + ", rpcMethod=" + getRPC();<a name="line.260"></a> +<span class="sourceLineNo">261</span> }<a name="line.261"></a> +<span class="sourceLineNo">262</span>}<a name="line.262"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/47be635d/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.State.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.State.html b/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.State.html index d489024..53051b3 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.State.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.State.html @@ -47,43 +47,45 @@ <span class="sourceLineNo">039</span> State getState();<a name="line.39"></a> <span class="sourceLineNo">040</span> long getStateTime();<a name="line.40"></a> <span class="sourceLineNo">041</span> long getCompletionTimestamp();<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span> void markComplete(String msg);<a name="line.43"></a> -<span class="sourceLineNo">044</span> void pause(String msg);<a name="line.44"></a> -<span class="sourceLineNo">045</span> void resume(String msg);<a name="line.45"></a> -<span class="sourceLineNo">046</span> void abort(String msg);<a name="line.46"></a> -<span class="sourceLineNo">047</span> void expireNow();<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> void setStatus(String status);<a name="line.49"></a> -<span class="sourceLineNo">050</span> void setDescription(String description);<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> * Explicitly mark this status as able to be cleaned up,<a name="line.53"></a> -<span class="sourceLineNo">054</span> * even though it might not be complete.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> void cleanup();<a name="line.56"></a> -<span class="sourceLineNo">057</span><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Public exposure of Object.clone() in order to allow clients to easily <a name="line.59"></a> -<span class="sourceLineNo">060</span> * capture current state.<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @return a copy of the object whose references will not change<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> MonitoredTask clone();<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> /**<a name="line.65"></a> -<span class="sourceLineNo">066</span> * Creates a string map of internal details for extensible exposure of <a name="line.66"></a> -<span class="sourceLineNo">067</span> * monitored tasks.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @return A Map containing information for this task.<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> Map<String, Object> toMap() throws IOException;<a name="line.70"></a> -<span class="sourceLineNo">071</span><a name="line.71"></a> -<span class="sourceLineNo">072</span> /**<a name="line.72"></a> -<span class="sourceLineNo">073</span> * Creates a JSON object for parseable exposure of monitored tasks.<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @return An encoded JSON object containing information for this task.<a name="line.74"></a> -<span class="sourceLineNo">075</span> */<a name="line.75"></a> -<span class="sourceLineNo">076</span> String toJSON() throws IOException;<a name="line.76"></a> -<span class="sourceLineNo">077</span><a name="line.77"></a> -<span class="sourceLineNo">078</span>}<a name="line.78"></a> +<span class="sourceLineNo">042</span> long getWarnTime();<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> +<span class="sourceLineNo">044</span> void markComplete(String msg);<a name="line.44"></a> +<span class="sourceLineNo">045</span> void pause(String msg);<a name="line.45"></a> +<span class="sourceLineNo">046</span> void resume(String msg);<a name="line.46"></a> +<span class="sourceLineNo">047</span> void abort(String msg);<a name="line.47"></a> +<span class="sourceLineNo">048</span> void expireNow();<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> void setStatus(String status);<a name="line.50"></a> +<span class="sourceLineNo">051</span> void setDescription(String description);<a name="line.51"></a> +<span class="sourceLineNo">052</span> void setWarnTime(final long t);<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Explicitly mark this status as able to be cleaned up,<a name="line.55"></a> +<span class="sourceLineNo">056</span> * even though it might not be complete.<a name="line.56"></a> +<span class="sourceLineNo">057</span> */<a name="line.57"></a> +<span class="sourceLineNo">058</span> void cleanup();<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> /**<a name="line.60"></a> +<span class="sourceLineNo">061</span> * Public exposure of Object.clone() in order to allow clients to easily <a name="line.61"></a> +<span class="sourceLineNo">062</span> * capture current state.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @return a copy of the object whose references will not change<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> MonitoredTask clone();<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * Creates a string map of internal details for extensible exposure of <a name="line.68"></a> +<span class="sourceLineNo">069</span> * monitored tasks.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @return A Map containing information for this task.<a name="line.70"></a> +<span class="sourceLineNo">071</span> */<a name="line.71"></a> +<span class="sourceLineNo">072</span> Map<String, Object> toMap() throws IOException;<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> * Creates a JSON object for parseable exposure of monitored tasks.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @return An encoded JSON object containing information for this task.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> String toJSON() throws IOException;<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> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/47be635d/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.html b/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.html index d489024..53051b3 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/monitoring/MonitoredTask.html @@ -47,43 +47,45 @@ <span class="sourceLineNo">039</span> State getState();<a name="line.39"></a> <span class="sourceLineNo">040</span> long getStateTime();<a name="line.40"></a> <span class="sourceLineNo">041</span> long getCompletionTimestamp();<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span> void markComplete(String msg);<a name="line.43"></a> -<span class="sourceLineNo">044</span> void pause(String msg);<a name="line.44"></a> -<span class="sourceLineNo">045</span> void resume(String msg);<a name="line.45"></a> -<span class="sourceLineNo">046</span> void abort(String msg);<a name="line.46"></a> -<span class="sourceLineNo">047</span> void expireNow();<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> void setStatus(String status);<a name="line.49"></a> -<span class="sourceLineNo">050</span> void setDescription(String description);<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> * Explicitly mark this status as able to be cleaned up,<a name="line.53"></a> -<span class="sourceLineNo">054</span> * even though it might not be complete.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> void cleanup();<a name="line.56"></a> -<span class="sourceLineNo">057</span><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Public exposure of Object.clone() in order to allow clients to easily <a name="line.59"></a> -<span class="sourceLineNo">060</span> * capture current state.<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @return a copy of the object whose references will not change<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> MonitoredTask clone();<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> /**<a name="line.65"></a> -<span class="sourceLineNo">066</span> * Creates a string map of internal details for extensible exposure of <a name="line.66"></a> -<span class="sourceLineNo">067</span> * monitored tasks.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @return A Map containing information for this task.<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> Map<String, Object> toMap() throws IOException;<a name="line.70"></a> -<span class="sourceLineNo">071</span><a name="line.71"></a> -<span class="sourceLineNo">072</span> /**<a name="line.72"></a> -<span class="sourceLineNo">073</span> * Creates a JSON object for parseable exposure of monitored tasks.<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @return An encoded JSON object containing information for this task.<a name="line.74"></a> -<span class="sourceLineNo">075</span> */<a name="line.75"></a> -<span class="sourceLineNo">076</span> String toJSON() throws IOException;<a name="line.76"></a> -<span class="sourceLineNo">077</span><a name="line.77"></a> -<span class="sourceLineNo">078</span>}<a name="line.78"></a> +<span class="sourceLineNo">042</span> long getWarnTime();<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> +<span class="sourceLineNo">044</span> void markComplete(String msg);<a name="line.44"></a> +<span class="sourceLineNo">045</span> void pause(String msg);<a name="line.45"></a> +<span class="sourceLineNo">046</span> void resume(String msg);<a name="line.46"></a> +<span class="sourceLineNo">047</span> void abort(String msg);<a name="line.47"></a> +<span class="sourceLineNo">048</span> void expireNow();<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> void setStatus(String status);<a name="line.50"></a> +<span class="sourceLineNo">051</span> void setDescription(String description);<a name="line.51"></a> +<span class="sourceLineNo">052</span> void setWarnTime(final long t);<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Explicitly mark this status as able to be cleaned up,<a name="line.55"></a> +<span class="sourceLineNo">056</span> * even though it might not be complete.<a name="line.56"></a> +<span class="sourceLineNo">057</span> */<a name="line.57"></a> +<span class="sourceLineNo">058</span> void cleanup();<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> /**<a name="line.60"></a> +<span class="sourceLineNo">061</span> * Public exposure of Object.clone() in order to allow clients to easily <a name="line.61"></a> +<span class="sourceLineNo">062</span> * capture current state.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @return a copy of the object whose references will not change<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> MonitoredTask clone();<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * Creates a string map of internal details for extensible exposure of <a name="line.68"></a> +<span class="sourceLineNo">069</span> * monitored tasks.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @return A Map containing information for this task.<a name="line.70"></a> +<span class="sourceLineNo">071</span> */<a name="line.71"></a> +<span class="sourceLineNo">072</span> Map<String, Object> toMap() throws IOException;<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> * Creates a JSON object for parseable exposure of monitored tasks.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @return An encoded JSON object containing information for this task.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> String toJSON() throws IOException;<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>
