http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1d9053bc/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html index 061ee4d..b1e6c5e 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html @@ -57,462 +57,462 @@ <span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.regionserver.Region;<a name="line.49"></a> <span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.regionserver.Region.Operation;<a name="line.50"></a> <span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.regionserver.RegionScanner;<a name="line.51"></a> -<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.regionserver.ScanType;<a name="line.52"></a> -<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.regionserver.Store;<a name="line.53"></a> -<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.regionserver.StoreFile;<a name="line.54"></a> -<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.regionserver.StoreFileReader;<a name="line.55"></a> -<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker;<a name="line.56"></a> -<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest;<a name="line.57"></a> -<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.regionserver.querymatcher.DeleteTracker;<a name="line.58"></a> -<span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.59"></a> -<span class="sourceLineNo">060</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.60"></a> -<span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.wal.WALKey;<a name="line.61"></a> -<span class="sourceLineNo">062</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.62"></a> -<span class="sourceLineNo">063</span>import org.apache.yetus.audience.InterfaceStability;<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> * Coprocessors implement this interface to observe and mediate client actions on the region.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> -<span class="sourceLineNo">068</span> * Since most implementations will be interested in only a subset of hooks, this class uses<a name="line.68"></a> -<span class="sourceLineNo">069</span> * 'default' functions to avoid having to add unnecessary overrides. When the functions are<a name="line.69"></a> -<span class="sourceLineNo">070</span> * non-empty, it's simply to satisfy the compiler by returning value of expected (non-void) type. It<a name="line.70"></a> -<span class="sourceLineNo">071</span> * is done in a way that these default definitions act as no-op. So our suggestion to implementation<a name="line.71"></a> -<span class="sourceLineNo">072</span> * would be to not call these 'default' methods from overrides.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * <h3>Exception Handling</h3><br><a name="line.74"></a> -<span class="sourceLineNo">075</span> * For all functions, exception handling is done as follows:<a name="line.75"></a> -<span class="sourceLineNo">076</span> * <ul><a name="line.76"></a> -<span class="sourceLineNo">077</span> * <li>Exceptions of type {@link IOException} are reported back to client.</li><a name="line.77"></a> -<span class="sourceLineNo">078</span> * <li>For any other kind of exception:<a name="line.78"></a> -<span class="sourceLineNo">079</span> * <ul><a name="line.79"></a> -<span class="sourceLineNo">080</span> * <li>If the configuration {@link CoprocessorHost#ABORT_ON_ERROR_KEY} is set to true, then the<a name="line.80"></a> -<span class="sourceLineNo">081</span> * server aborts.</li><a name="line.81"></a> -<span class="sourceLineNo">082</span> * <li>Otherwise, coprocessor is removed from the server and<a name="line.82"></a> -<span class="sourceLineNo">083</span> * {@link org.apache.hadoop.hbase.DoNotRetryIOException} is returned to the client.</li><a name="line.83"></a> -<span class="sourceLineNo">084</span> * </ul><a name="line.84"></a> -<span class="sourceLineNo">085</span> * </li><a name="line.85"></a> -<span class="sourceLineNo">086</span> * </ul><a name="line.86"></a> -<span class="sourceLineNo">087</span> * <p><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <h3>For Split Related Hooks</h3> <br><a name="line.88"></a> -<span class="sourceLineNo">089</span> * In hbase2/AMv2, master runs splits, so the split related hooks are moved to<a name="line.89"></a> -<span class="sourceLineNo">090</span> * {@link MasterObserver}.<a name="line.90"></a> -<span class="sourceLineNo">091</span> * <p><a name="line.91"></a> -<span class="sourceLineNo">092</span> * <h3>Increment Column Value</h3><br><a name="line.92"></a> -<span class="sourceLineNo">093</span> * We do not call this hook anymore.<a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.95"></a> -<span class="sourceLineNo">096</span>@InterfaceStability.Evolving<a name="line.96"></a> -<span class="sourceLineNo">097</span>// TODO as method signatures need to break, update to<a name="line.97"></a> -<span class="sourceLineNo">098</span>// ObserverContext<? extends RegionCoprocessorEnvironment><a name="line.98"></a> -<span class="sourceLineNo">099</span>// so we can use additional environment state that isn't exposed to coprocessors.<a name="line.99"></a> -<span class="sourceLineNo">100</span>public interface RegionObserver {<a name="line.100"></a> -<span class="sourceLineNo">101</span> /** Mutation type for postMutationBeforeWAL hook */<a name="line.101"></a> -<span class="sourceLineNo">102</span> enum MutationType {<a name="line.102"></a> -<span class="sourceLineNo">103</span> APPEND, INCREMENT<a name="line.103"></a> -<span class="sourceLineNo">104</span> }<a name="line.104"></a> -<span class="sourceLineNo">105</span><a name="line.105"></a> -<span class="sourceLineNo">106</span> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * Called before the region is reported as open to the master.<a name="line.107"></a> -<span class="sourceLineNo">108</span> * @param c the environment provided by the region server<a name="line.108"></a> -<span class="sourceLineNo">109</span> */<a name="line.109"></a> -<span class="sourceLineNo">110</span> default void preOpen(ObserverContext<RegionCoprocessorEnvironment> c) throws IOException {}<a name="line.110"></a> -<span class="sourceLineNo">111</span><a name="line.111"></a> -<span class="sourceLineNo">112</span> /**<a name="line.112"></a> -<span class="sourceLineNo">113</span> * Called after the region is reported as open to the master.<a name="line.113"></a> -<span class="sourceLineNo">114</span> * @param c the environment provided by the region server<a name="line.114"></a> -<span class="sourceLineNo">115</span> */<a name="line.115"></a> -<span class="sourceLineNo">116</span> default void postOpen(ObserverContext<RegionCoprocessorEnvironment> c) {}<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> * Called after the log replay on the region is over.<a name="line.119"></a> -<span class="sourceLineNo">120</span> * @param c the environment provided by the region server<a name="line.120"></a> -<span class="sourceLineNo">121</span> */<a name="line.121"></a> -<span class="sourceLineNo">122</span> default void postLogReplay(ObserverContext<RegionCoprocessorEnvironment> c) {}<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> * Called before the memstore is flushed to disk.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param c the environment provided by the region server<a name="line.126"></a> -<span class="sourceLineNo">127</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.127"></a> -<span class="sourceLineNo">128</span> */<a name="line.128"></a> -<span class="sourceLineNo">129</span> default void preFlush(final ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.129"></a> -<span class="sourceLineNo">130</span> FlushLifeCycleTracker tracker) throws IOException {}<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> * Called before a Store's memstore is flushed to disk.<a name="line.133"></a> -<span class="sourceLineNo">134</span> * @param c the environment provided by the region server<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @param store the store where compaction is being requested<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @param scanner the scanner over existing data used in the store file<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.137"></a> -<span class="sourceLineNo">138</span> * @return the scanner to use during compaction. Should not be {@code null}<a name="line.138"></a> -<span class="sourceLineNo">139</span> * unless the implementation is writing new store files on its own.<a name="line.139"></a> -<span class="sourceLineNo">140</span> */<a name="line.140"></a> -<span class="sourceLineNo">141</span> default InternalScanner preFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.141"></a> -<span class="sourceLineNo">142</span> InternalScanner scanner, FlushLifeCycleTracker tracker) throws IOException {<a name="line.142"></a> -<span class="sourceLineNo">143</span> return scanner;<a name="line.143"></a> -<span class="sourceLineNo">144</span> }<a name="line.144"></a> -<span class="sourceLineNo">145</span><a name="line.145"></a> -<span class="sourceLineNo">146</span> /**<a name="line.146"></a> -<span class="sourceLineNo">147</span> * Called after the memstore is flushed to disk.<a name="line.147"></a> -<span class="sourceLineNo">148</span> * @param c the environment provided by the region server<a name="line.148"></a> -<span class="sourceLineNo">149</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @throws IOException if an error occurred on the coprocessor<a name="line.150"></a> +<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.regionserver.ScanOptions;<a name="line.52"></a> +<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.regionserver.ScanType;<a name="line.53"></a> +<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.regionserver.Store;<a name="line.54"></a> +<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.regionserver.StoreFile;<a name="line.55"></a> +<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.regionserver.StoreFileReader;<a name="line.56"></a> +<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker;<a name="line.57"></a> +<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest;<a name="line.58"></a> +<span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.regionserver.querymatcher.DeleteTracker;<a name="line.59"></a> +<span class="sourceLineNo">060</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.60"></a> +<span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.61"></a> +<span class="sourceLineNo">062</span>import org.apache.hadoop.hbase.wal.WALKey;<a name="line.62"></a> +<span class="sourceLineNo">063</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.63"></a> +<span class="sourceLineNo">064</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span>/**<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Coprocessors implement this interface to observe and mediate client actions on the region.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <p><a name="line.68"></a> +<span class="sourceLineNo">069</span> * Since most implementations will be interested in only a subset of hooks, this class uses<a name="line.69"></a> +<span class="sourceLineNo">070</span> * 'default' functions to avoid having to add unnecessary overrides. When the functions are<a name="line.70"></a> +<span class="sourceLineNo">071</span> * non-empty, it's simply to satisfy the compiler by returning value of expected (non-void) type. It<a name="line.71"></a> +<span class="sourceLineNo">072</span> * is done in a way that these default definitions act as no-op. So our suggestion to implementation<a name="line.72"></a> +<span class="sourceLineNo">073</span> * would be to not call these 'default' methods from overrides.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * <p><a name="line.74"></a> +<span class="sourceLineNo">075</span> * <h3>Exception Handling</h3><br><a name="line.75"></a> +<span class="sourceLineNo">076</span> * For all functions, exception handling is done as follows:<a name="line.76"></a> +<span class="sourceLineNo">077</span> * <ul><a name="line.77"></a> +<span class="sourceLineNo">078</span> * <li>Exceptions of type {@link IOException} are reported back to client.</li><a name="line.78"></a> +<span class="sourceLineNo">079</span> * <li>For any other kind of exception:<a name="line.79"></a> +<span class="sourceLineNo">080</span> * <ul><a name="line.80"></a> +<span class="sourceLineNo">081</span> * <li>If the configuration {@link CoprocessorHost#ABORT_ON_ERROR_KEY} is set to true, then the<a name="line.81"></a> +<span class="sourceLineNo">082</span> * server aborts.</li><a name="line.82"></a> +<span class="sourceLineNo">083</span> * <li>Otherwise, coprocessor is removed from the server and<a name="line.83"></a> +<span class="sourceLineNo">084</span> * {@link org.apache.hadoop.hbase.DoNotRetryIOException} is returned to the client.</li><a name="line.84"></a> +<span class="sourceLineNo">085</span> * </ul><a name="line.85"></a> +<span class="sourceLineNo">086</span> * </li><a name="line.86"></a> +<span class="sourceLineNo">087</span> * </ul><a name="line.87"></a> +<span class="sourceLineNo">088</span> * <p><a name="line.88"></a> +<span class="sourceLineNo">089</span> * <h3>For Split Related Hooks</h3> <br><a name="line.89"></a> +<span class="sourceLineNo">090</span> * In hbase2/AMv2, master runs splits, so the split related hooks are moved to<a name="line.90"></a> +<span class="sourceLineNo">091</span> * {@link MasterObserver}.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> +<span class="sourceLineNo">093</span> * <h3>Increment Column Value</h3><br><a name="line.93"></a> +<span class="sourceLineNo">094</span> * We do not call this hook anymore.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.96"></a> +<span class="sourceLineNo">097</span>@InterfaceStability.Evolving<a name="line.97"></a> +<span class="sourceLineNo">098</span>// TODO as method signatures need to break, update to<a name="line.98"></a> +<span class="sourceLineNo">099</span>// ObserverContext<? extends RegionCoprocessorEnvironment><a name="line.99"></a> +<span class="sourceLineNo">100</span>// so we can use additional environment state that isn't exposed to coprocessors.<a name="line.100"></a> +<span class="sourceLineNo">101</span>public interface RegionObserver {<a name="line.101"></a> +<span class="sourceLineNo">102</span> /** Mutation type for postMutationBeforeWAL hook */<a name="line.102"></a> +<span class="sourceLineNo">103</span> enum MutationType {<a name="line.103"></a> +<span class="sourceLineNo">104</span> APPEND, INCREMENT<a name="line.104"></a> +<span class="sourceLineNo">105</span> }<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> /**<a name="line.107"></a> +<span class="sourceLineNo">108</span> * Called before the region is reported as open to the master.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @param c the environment provided by the region server<a name="line.109"></a> +<span class="sourceLineNo">110</span> */<a name="line.110"></a> +<span class="sourceLineNo">111</span> default void preOpen(ObserverContext<RegionCoprocessorEnvironment> c) throws IOException {}<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> * Called after the region is reported as open to the master.<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @param c the environment provided by the region server<a name="line.115"></a> +<span class="sourceLineNo">116</span> */<a name="line.116"></a> +<span class="sourceLineNo">117</span> default void postOpen(ObserverContext<RegionCoprocessorEnvironment> c) {}<a name="line.117"></a> +<span class="sourceLineNo">118</span><a name="line.118"></a> +<span class="sourceLineNo">119</span> /**<a name="line.119"></a> +<span class="sourceLineNo">120</span> * Called after the log replay on the region is over.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @param c the environment provided by the region server<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> default void postLogReplay(ObserverContext<RegionCoprocessorEnvironment> c) {}<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * Called before the memstore is flushed to disk.<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @param c the environment provided by the region server<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.128"></a> +<span class="sourceLineNo">129</span> */<a name="line.129"></a> +<span class="sourceLineNo">130</span> default void preFlush(final ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.130"></a> +<span class="sourceLineNo">131</span> FlushLifeCycleTracker tracker) throws IOException {}<a name="line.131"></a> +<span class="sourceLineNo">132</span><a name="line.132"></a> +<span class="sourceLineNo">133</span> /**<a name="line.133"></a> +<span class="sourceLineNo">134</span> * Called before we open store scanner for flush. You can use the {@code options} to change max<a name="line.134"></a> +<span class="sourceLineNo">135</span> * versions and TTL for the scanner being opened.<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @param c the environment provided by the region server<a name="line.136"></a> +<span class="sourceLineNo">137</span> * @param store the store where flush is being requested<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @param options used to change max versions and TTL for the scanner being opened<a name="line.138"></a> +<span class="sourceLineNo">139</span> */<a name="line.139"></a> +<span class="sourceLineNo">140</span> default void preFlushScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.140"></a> +<span class="sourceLineNo">141</span> ScanOptions options,FlushLifeCycleTracker tracker) throws IOException {}<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> * Called before a Store's memstore is flushed to disk.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param c the environment provided by the region server<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @param store the store where flush is being requested<a name="line.146"></a> +<span class="sourceLineNo">147</span> * @param scanner the scanner over existing data used in the store file<a name="line.147"></a> +<span class="sourceLineNo">148</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @return the scanner to use during compaction. Should not be {@code null}<a name="line.149"></a> +<span class="sourceLineNo">150</span> * unless the implementation is writing new store files on its own.<a name="line.150"></a> <span class="sourceLineNo">151</span> */<a name="line.151"></a> -<span class="sourceLineNo">152</span> default void postFlush(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.152"></a> -<span class="sourceLineNo">153</span> FlushLifeCycleTracker tracker) throws IOException {}<a name="line.153"></a> -<span class="sourceLineNo">154</span><a name="line.154"></a> -<span class="sourceLineNo">155</span> /**<a name="line.155"></a> -<span class="sourceLineNo">156</span> * Called after a Store's memstore is flushed to disk.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param c the environment provided by the region server<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @param store the store being flushed<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @param resultFile the new store file written out during compaction<a name="line.159"></a> +<span class="sourceLineNo">152</span> default InternalScanner preFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.152"></a> +<span class="sourceLineNo">153</span> InternalScanner scanner, FlushLifeCycleTracker tracker) throws IOException {<a name="line.153"></a> +<span class="sourceLineNo">154</span> return scanner;<a name="line.154"></a> +<span class="sourceLineNo">155</span> }<a name="line.155"></a> +<span class="sourceLineNo">156</span><a name="line.156"></a> +<span class="sourceLineNo">157</span> /**<a name="line.157"></a> +<span class="sourceLineNo">158</span> * Called after the memstore is flushed to disk.<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @param c the environment provided by the region server<a name="line.159"></a> <span class="sourceLineNo">160</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.160"></a> -<span class="sourceLineNo">161</span> */<a name="line.161"></a> -<span class="sourceLineNo">162</span> default void postFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.162"></a> -<span class="sourceLineNo">163</span> StoreFile resultFile, FlushLifeCycleTracker tracker) throws IOException {}<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> /**<a name="line.165"></a> -<span class="sourceLineNo">166</span> * Called prior to selecting the {@link StoreFile StoreFiles} to compact from the list of<a name="line.166"></a> -<span class="sourceLineNo">167</span> * available candidates. To alter the files used for compaction, you may mutate the passed in list<a name="line.167"></a> -<span class="sourceLineNo">168</span> * of candidates. If you remove all the candidates then the compaction will be canceled.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @param c the environment provided by the region server<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @param store the store where compaction is being requested<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @param candidates the store files currently available for compaction<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> default void preCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.174"></a> -<span class="sourceLineNo">175</span> List<? extends StoreFile> candidates, CompactionLifeCycleTracker tracker)<a name="line.175"></a> -<span class="sourceLineNo">176</span> throws IOException {}<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Called after the {@link StoreFile}s to compact have been selected from the available<a name="line.179"></a> -<span class="sourceLineNo">180</span> * candidates.<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @param c the environment provided by the region server<a name="line.181"></a> -<span class="sourceLineNo">182</span> * @param store the store being compacted<a name="line.182"></a> -<span class="sourceLineNo">183</span> * @param selected the store files selected to compact<a name="line.183"></a> -<span class="sourceLineNo">184</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.184"></a> -<span class="sourceLineNo">185</span> * @param request the requested compaction<a name="line.185"></a> -<span class="sourceLineNo">186</span> */<a name="line.186"></a> -<span class="sourceLineNo">187</span> default void postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.187"></a> -<span class="sourceLineNo">188</span> List<? extends StoreFile> selected, CompactionLifeCycleTracker tracker,<a name="line.188"></a> -<span class="sourceLineNo">189</span> CompactionRequest request) {}<a name="line.189"></a> -<span class="sourceLineNo">190</span><a name="line.190"></a> -<span class="sourceLineNo">191</span> /**<a name="line.191"></a> -<span class="sourceLineNo">192</span> * Called prior to writing the {@link StoreFile}s selected for compaction into a new<a name="line.192"></a> -<span class="sourceLineNo">193</span> * {@code StoreFile}.<a name="line.193"></a> -<span class="sourceLineNo">194</span> * <p><a name="line.194"></a> -<span class="sourceLineNo">195</span> * To override or modify the compaction process, implementing classes can wrap the provided<a name="line.195"></a> -<span class="sourceLineNo">196</span> * {@link InternalScanner} with a custom implementation that is returned from this method. The<a name="line.196"></a> -<span class="sourceLineNo">197</span> * custom scanner can then inspect {@link org.apache.hadoop.hbase.Cell}s from the wrapped scanner,<a name="line.197"></a> -<span class="sourceLineNo">198</span> * applying its own policy to what gets written.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @param c the environment provided by the region server<a name="line.199"></a> -<span class="sourceLineNo">200</span> * @param store the store being compacted<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @param scanner the scanner over existing data used in the store file rewriting<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param scanType type of Scan<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.203"></a> -<span class="sourceLineNo">204</span> * @param request the requested compaction<a name="line.204"></a> -<span class="sourceLineNo">205</span> * @return the scanner to use during compaction. Should not be {@code null} unless the<a name="line.205"></a> -<span class="sourceLineNo">206</span> * implementation is writing new store files on its own.<a name="line.206"></a> -<span class="sourceLineNo">207</span> */<a name="line.207"></a> -<span class="sourceLineNo">208</span> default InternalScanner preCompact(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.208"></a> -<span class="sourceLineNo">209</span> InternalScanner scanner, ScanType scanType, CompactionLifeCycleTracker tracker,<a name="line.209"></a> -<span class="sourceLineNo">210</span> CompactionRequest request) throws IOException {<a name="line.210"></a> -<span class="sourceLineNo">211</span> return scanner;<a name="line.211"></a> -<span class="sourceLineNo">212</span> }<a name="line.212"></a> -<span class="sourceLineNo">213</span><a name="line.213"></a> -<span class="sourceLineNo">214</span> /**<a name="line.214"></a> -<span class="sourceLineNo">215</span> * Called after compaction has completed and the new store file has been moved in to place.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @param c the environment provided by the region server<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param store the store being compacted<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @param resultFile the new store file written out during compaction<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @param tracker used to track the life cycle of a compaction<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @param request the requested compaction<a name="line.220"></a> -<span class="sourceLineNo">221</span> */<a name="line.221"></a> -<span class="sourceLineNo">222</span> default void postCompact(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.222"></a> -<span class="sourceLineNo">223</span> StoreFile resultFile, CompactionLifeCycleTracker tracker, CompactionRequest request)<a name="line.223"></a> -<span class="sourceLineNo">224</span> throws IOException {}<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> /**<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Called before the region is reported as closed to the master.<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @param c the environment provided by the region server<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @param abortRequested true if the region server is aborting<a name="line.229"></a> -<span class="sourceLineNo">230</span> */<a name="line.230"></a> -<span class="sourceLineNo">231</span> default void preClose(ObserverContext<RegionCoprocessorEnvironment> c, boolean abortRequested)<a name="line.231"></a> -<span class="sourceLineNo">232</span> throws IOException {}<a name="line.232"></a> -<span class="sourceLineNo">233</span><a name="line.233"></a> -<span class="sourceLineNo">234</span> /**<a name="line.234"></a> -<span class="sourceLineNo">235</span> * Called after the region is reported as closed to the master.<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @param c the environment provided by the region server<a name="line.236"></a> -<span class="sourceLineNo">237</span> * @param abortRequested true if the region server is aborting<a name="line.237"></a> -<span class="sourceLineNo">238</span> */<a name="line.238"></a> -<span class="sourceLineNo">239</span> default void postClose(ObserverContext<RegionCoprocessorEnvironment> c, boolean abortRequested) {}<a name="line.239"></a> -<span class="sourceLineNo">240</span><a name="line.240"></a> -<span class="sourceLineNo">241</span> /**<a name="line.241"></a> -<span class="sourceLineNo">242</span> * Called before the client performs a Get<a name="line.242"></a> -<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> -<span class="sourceLineNo">244</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.244"></a> -<span class="sourceLineNo">245</span> * <p><a name="line.245"></a> -<span class="sourceLineNo">246</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.246"></a> -<span class="sourceLineNo">247</span> * coprocessors<a name="line.247"></a> -<span class="sourceLineNo">248</span> * @param c the environment provided by the region server<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @param get the Get request<a name="line.249"></a> -<span class="sourceLineNo">250</span> * @param result The result to return to the client if default processing<a name="line.250"></a> -<span class="sourceLineNo">251</span> * is bypassed. Can be modified. Will not be used if default processing<a name="line.251"></a> -<span class="sourceLineNo">252</span> * is not bypassed.<a name="line.252"></a> -<span class="sourceLineNo">253</span> */<a name="line.253"></a> -<span class="sourceLineNo">254</span> default void preGetOp(ObserverContext<RegionCoprocessorEnvironment> c, Get get, List<Cell> result)<a name="line.254"></a> -<span class="sourceLineNo">255</span> throws IOException {}<a name="line.255"></a> -<span class="sourceLineNo">256</span><a name="line.256"></a> -<span class="sourceLineNo">257</span> /**<a name="line.257"></a> -<span class="sourceLineNo">258</span> * Called after the client performs a Get<a name="line.258"></a> -<span class="sourceLineNo">259</span> * <p><a name="line.259"></a> -<span class="sourceLineNo">260</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.260"></a> -<span class="sourceLineNo">261</span> * coprocessors<a name="line.261"></a> -<span class="sourceLineNo">262</span> * <p><a name="line.262"></a> -<span class="sourceLineNo">263</span> * Note: Do not retain references to any Cells in 'result' beyond the life of this invocation.<a name="line.263"></a> -<span class="sourceLineNo">264</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @param c the environment provided by the region server<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @param get the Get request<a name="line.266"></a> -<span class="sourceLineNo">267</span> * @param result the result to return to the client, modify as necessary<a name="line.267"></a> -<span class="sourceLineNo">268</span> */<a name="line.268"></a> -<span class="sourceLineNo">269</span> default void postGetOp(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.269"></a> -<span class="sourceLineNo">270</span> List<Cell> result) throws IOException {}<a name="line.270"></a> -<span class="sourceLineNo">271</span><a name="line.271"></a> -<span class="sourceLineNo">272</span> /**<a name="line.272"></a> -<span class="sourceLineNo">273</span> * Called before the client tests for existence using a Get.<a name="line.273"></a> -<span class="sourceLineNo">274</span> * <p><a name="line.274"></a> -<span class="sourceLineNo">275</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.275"></a> -<span class="sourceLineNo">276</span> * <p><a name="line.276"></a> -<span class="sourceLineNo">277</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.277"></a> -<span class="sourceLineNo">278</span> * coprocessors<a name="line.278"></a> -<span class="sourceLineNo">279</span> * @param c the environment provided by the region server<a name="line.279"></a> -<span class="sourceLineNo">280</span> * @param get the Get request<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @param exists the result returned by the region server<a name="line.281"></a> -<span class="sourceLineNo">282</span> * @return the value to return to the client if bypassing default processing<a name="line.282"></a> -<span class="sourceLineNo">283</span> */<a name="line.283"></a> -<span class="sourceLineNo">284</span> default boolean preExists(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.284"></a> -<span class="sourceLineNo">285</span> boolean exists) throws IOException {<a name="line.285"></a> -<span class="sourceLineNo">286</span> return exists;<a name="line.286"></a> -<span class="sourceLineNo">287</span> }<a name="line.287"></a> -<span class="sourceLineNo">288</span><a name="line.288"></a> -<span class="sourceLineNo">289</span> /**<a name="line.289"></a> -<span class="sourceLineNo">290</span> * Called after the client tests for existence using a Get.<a name="line.290"></a> -<span class="sourceLineNo">291</span> * <p><a name="line.291"></a> -<span class="sourceLineNo">292</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.292"></a> -<span class="sourceLineNo">293</span> * coprocessors<a name="line.293"></a> -<span class="sourceLineNo">294</span> * @param c the environment provided by the region server<a name="line.294"></a> -<span class="sourceLineNo">295</span> * @param get the Get request<a name="line.295"></a> -<span class="sourceLineNo">296</span> * @param exists the result returned by the region server<a name="line.296"></a> -<span class="sourceLineNo">297</span> * @return the result to return to the client<a name="line.297"></a> -<span class="sourceLineNo">298</span> */<a name="line.298"></a> -<span class="sourceLineNo">299</span> default boolean postExists(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.299"></a> -<span class="sourceLineNo">300</span> boolean exists) throws IOException {<a name="line.300"></a> -<span class="sourceLineNo">301</span> return exists;<a name="line.301"></a> -<span class="sourceLineNo">302</span> }<a name="line.302"></a> -<span class="sourceLineNo">303</span><a name="line.303"></a> -<span class="sourceLineNo">304</span> /**<a name="line.304"></a> -<span class="sourceLineNo">305</span> * Called before the client stores a value.<a name="line.305"></a> -<span class="sourceLineNo">306</span> * <p><a name="line.306"></a> -<span class="sourceLineNo">307</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.307"></a> -<span class="sourceLineNo">308</span> * <p><a name="line.308"></a> -<span class="sourceLineNo">309</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.309"></a> -<span class="sourceLineNo">310</span> * coprocessors<a name="line.310"></a> -<span class="sourceLineNo">311</span> * <p><a name="line.311"></a> -<span class="sourceLineNo">312</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.312"></a> -<span class="sourceLineNo">313</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @param c the environment provided by the region server<a name="line.314"></a> -<span class="sourceLineNo">315</span> * @param put The Put object<a name="line.315"></a> -<span class="sourceLineNo">316</span> * @param edit The WALEdit object that will be written to the wal<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @param durability Persistence guarantee for this Put<a name="line.317"></a> -<span class="sourceLineNo">318</span> */<a name="line.318"></a> -<span class="sourceLineNo">319</span> default void prePut(ObserverContext<RegionCoprocessorEnvironment> c, Put put, WALEdit edit,<a name="line.319"></a> -<span class="sourceLineNo">320</span> Durability durability) throws IOException {}<a name="line.320"></a> -<span class="sourceLineNo">321</span><a name="line.321"></a> -<span class="sourceLineNo">322</span> /**<a name="line.322"></a> -<span class="sourceLineNo">323</span> * Called after the client stores a value.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * <p><a name="line.324"></a> -<span class="sourceLineNo">325</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.325"></a> -<span class="sourceLineNo">326</span> * coprocessors<a name="line.326"></a> -<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> -<span class="sourceLineNo">328</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * @param c the environment provided by the region server<a name="line.330"></a> -<span class="sourceLineNo">331</span> * @param put The Put object<a name="line.331"></a> -<span class="sourceLineNo">332</span> * @param edit The WALEdit object for the wal<a name="line.332"></a> -<span class="sourceLineNo">333</span> * @param durability Persistence guarantee for this Put<a name="line.333"></a> -<span class="sourceLineNo">334</span> */<a name="line.334"></a> -<span class="sourceLineNo">335</span> default void postPut(ObserverContext<RegionCoprocessorEnvironment> c, Put put, WALEdit edit,<a name="line.335"></a> -<span class="sourceLineNo">336</span> Durability durability) throws IOException {}<a name="line.336"></a> -<span class="sourceLineNo">337</span><a name="line.337"></a> -<span class="sourceLineNo">338</span> /**<a name="line.338"></a> -<span class="sourceLineNo">339</span> * Called before the client deletes a value.<a name="line.339"></a> -<span class="sourceLineNo">340</span> * <p><a name="line.340"></a> -<span class="sourceLineNo">341</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.341"></a> -<span class="sourceLineNo">342</span> * <p><a name="line.342"></a> -<span class="sourceLineNo">343</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.343"></a> -<span class="sourceLineNo">344</span> * coprocessors<a name="line.344"></a> -<span class="sourceLineNo">345</span> * <p><a name="line.345"></a> -<span class="sourceLineNo">346</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.346"></a> -<span class="sourceLineNo">347</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @param c the environment provided by the region server<a name="line.348"></a> -<span class="sourceLineNo">349</span> * @param delete The Delete object<a name="line.349"></a> -<span class="sourceLineNo">350</span> * @param edit The WALEdit object for the wal<a name="line.350"></a> -<span class="sourceLineNo">351</span> * @param durability Persistence guarantee for this Delete<a name="line.351"></a> -<span class="sourceLineNo">352</span> */<a name="line.352"></a> -<span class="sourceLineNo">353</span> default void preDelete(ObserverContext<RegionCoprocessorEnvironment> c, Delete delete,<a name="line.353"></a> -<span class="sourceLineNo">354</span> WALEdit edit, Durability durability) throws IOException {}<a name="line.354"></a> -<span class="sourceLineNo">355</span><a name="line.355"></a> -<span class="sourceLineNo">356</span> /**<a name="line.356"></a> -<span class="sourceLineNo">357</span> * Called before the server updates the timestamp for version delete with latest timestamp.<a name="line.357"></a> -<span class="sourceLineNo">358</span> * <p><a name="line.358"></a> -<span class="sourceLineNo">359</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.359"></a> -<span class="sourceLineNo">360</span> * <p><a name="line.360"></a> -<span class="sourceLineNo">361</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors<a name="line.361"></a> -<span class="sourceLineNo">362</span> * @param c the environment provided by the region server<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @param mutation - the parent mutation associated with this delete cell<a name="line.363"></a> -<span class="sourceLineNo">364</span> * @param cell - The deleteColumn with latest version cell<a name="line.364"></a> -<span class="sourceLineNo">365</span> * @param byteNow - timestamp bytes<a name="line.365"></a> -<span class="sourceLineNo">366</span> * @param get - the get formed using the current cell's row. Note that the get does not specify<a name="line.366"></a> -<span class="sourceLineNo">367</span> * the family and qualifier<a name="line.367"></a> -<span class="sourceLineNo">368</span> */<a name="line.368"></a> -<span class="sourceLineNo">369</span> default void prePrepareTimeStampForDeleteVersion(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.369"></a> -<span class="sourceLineNo">370</span> Mutation mutation, Cell cell, byte[] byteNow, Get get) throws IOException {}<a name="line.370"></a> -<span class="sourceLineNo">371</span><a name="line.371"></a> -<span class="sourceLineNo">372</span> /**<a name="line.372"></a> -<span class="sourceLineNo">373</span> * Called after the client deletes a value.<a name="line.373"></a> -<span class="sourceLineNo">374</span> * <p><a name="line.374"></a> -<span class="sourceLineNo">375</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.375"></a> -<span class="sourceLineNo">376</span> * coprocessors<a name="line.376"></a> -<span class="sourceLineNo">377</span> * <p><a name="line.377"></a> -<span class="sourceLineNo">378</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.378"></a> -<span class="sourceLineNo">379</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.379"></a> -<span class="sourceLineNo">380</span> * @param c the environment provided by the region server<a name="line.380"></a> -<span class="sourceLineNo">381</span> * @param delete The Delete object<a name="line.381"></a> -<span class="sourceLineNo">382</span> * @param edit The WALEdit object for the wal<a name="line.382"></a> -<span class="sourceLineNo">383</span> * @param durability Persistence guarantee for this Delete<a name="line.383"></a> -<span class="sourceLineNo">384</span> */<a name="line.384"></a> -<span class="sourceLineNo">385</span> default void postDelete(ObserverContext<RegionCoprocessorEnvironment> c, Delete delete,<a name="line.385"></a> -<span class="sourceLineNo">386</span> WALEdit edit, Durability durability) throws IOException {}<a name="line.386"></a> -<span class="sourceLineNo">387</span><a name="line.387"></a> -<span class="sourceLineNo">388</span> /**<a name="line.388"></a> -<span class="sourceLineNo">389</span> * This will be called for every batch mutation operation happening at the server. This will be<a name="line.389"></a> -<span class="sourceLineNo">390</span> * called after acquiring the locks on the mutating rows and after applying the proper timestamp<a name="line.390"></a> -<span class="sourceLineNo">391</span> * for each Mutation at the server. The batch may contain Put/Delete. By setting OperationStatus<a name="line.391"></a> -<span class="sourceLineNo">392</span> * of Mutations ({@link MiniBatchOperationInProgress#setOperationStatus(int, OperationStatus)}),<a name="line.392"></a> -<span class="sourceLineNo">393</span> * {@link RegionObserver} can make Region to skip these Mutations.<a name="line.393"></a> -<span class="sourceLineNo">394</span> * <p><a name="line.394"></a> -<span class="sourceLineNo">395</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.395"></a> -<span class="sourceLineNo">396</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.396"></a> -<span class="sourceLineNo">397</span> * @param c the environment provided by the region server<a name="line.397"></a> -<span class="sourceLineNo">398</span> * @param miniBatchOp batch of Mutations getting applied to region.<a name="line.398"></a> -<span class="sourceLineNo">399</span> */<a name="line.399"></a> -<span class="sourceLineNo">400</span> default void preBatchMutate(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.400"></a> -<span class="sourceLineNo">401</span> MiniBatchOperationInProgress<Mutation> miniBatchOp) throws IOException {}<a name="line.401"></a> -<span class="sourceLineNo">402</span><a name="line.402"></a> -<span class="sourceLineNo">403</span> /**<a name="line.403"></a> -<span class="sourceLineNo">404</span> * This will be called after applying a batch of Mutations on a region. The Mutations are added to<a name="line.404"></a> -<span class="sourceLineNo">405</span> * memstore and WAL. The difference of this one with<a name="line.405"></a> -<span class="sourceLineNo">406</span> * {@link #postPut(ObserverContext, Put, WALEdit, Durability) }<a name="line.406"></a> -<span class="sourceLineNo">407</span> * and {@link #postDelete(ObserverContext, Delete, WALEdit, Durability) } is<a name="line.407"></a> -<span class="sourceLineNo">408</span> * this hook will be executed before the mvcc transaction completion.<a name="line.408"></a> -<span class="sourceLineNo">409</span> * <p><a name="line.409"></a> -<span class="sourceLineNo">410</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.410"></a> -<span class="sourceLineNo">411</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.411"></a> -<span class="sourceLineNo">412</span> * @param c the environment provided by the region server<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param miniBatchOp batch of Mutations applied to region.<a name="line.413"></a> -<span class="sourceLineNo">414</span> */<a name="line.414"></a> -<span class="sourceLineNo">415</span> default void postBatchMutate(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.415"></a> -<span class="sourceLineNo">416</span> MiniBatchOperationInProgress<Mutation> miniBatchOp) throws IOException {}<a name="line.416"></a> -<span class="sourceLineNo">417</span><a name="line.417"></a> -<span class="sourceLineNo">418</span> /**<a name="line.418"></a> -<span class="sourceLineNo">419</span> * This will be called for region operations where read lock is acquired in<a name="line.419"></a> -<span class="sourceLineNo">420</span> * {@link Region#startRegionOperation()}.<a name="line.420"></a> -<span class="sourceLineNo">421</span> * @param ctx<a name="line.421"></a> -<span class="sourceLineNo">422</span> * @param operation The operation is about to be taken on the region<a name="line.422"></a> -<span class="sourceLineNo">423</span> */<a name="line.423"></a> -<span class="sourceLineNo">424</span> default void postStartRegionOperation(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.424"></a> -<span class="sourceLineNo">425</span> Operation operation) throws IOException {}<a name="line.425"></a> -<span class="sourceLineNo">426</span><a name="line.426"></a> -<span class="sourceLineNo">427</span> /**<a name="line.427"></a> -<span class="sourceLineNo">428</span> * Called after releasing read lock in {@link Region#closeRegionOperation()}.<a name="line.428"></a> -<span class="sourceLineNo">429</span> * @param ctx<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param operation<a name="line.430"></a> -<span class="sourceLineNo">431</span> */<a name="line.431"></a> -<span class="sourceLineNo">432</span> default void postCloseRegionOperation(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.432"></a> -<span class="sourceLineNo">433</span> Operation operation) throws IOException {}<a name="line.433"></a> -<span class="sourceLineNo">434</span><a name="line.434"></a> -<span class="sourceLineNo">435</span> /**<a name="line.435"></a> -<span class="sourceLineNo">436</span> * Called after the completion of batch put/delete and will be called even if the batch operation<a name="line.436"></a> -<span class="sourceLineNo">437</span> * fails.<a name="line.437"></a> -<span class="sourceLineNo">438</span> * <p><a name="line.438"></a> -<span class="sourceLineNo">439</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.439"></a> -<span class="sourceLineNo">440</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.440"></a> -<span class="sourceLineNo">441</span> * @param ctx<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @param miniBatchOp<a name="line.442"></a> -<span class="sourceLineNo">443</span> * @param success true if batch operation is successful otherwise false.<a name="line.443"></a> -<span class="sourceLineNo">444</span> */<a name="line.444"></a> -<span class="sourceLineNo">445</span> default void postBatchMutateIndispensably(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.445"></a> -<span class="sourceLineNo">446</span> MiniBatchOperationInProgress<Mutation> miniBatchOp, boolean success) throws IOException {}<a name="line.446"></a> -<span class="sourceLineNo">447</span><a name="line.447"></a> -<span class="sourceLineNo">448</span> /**<a name="line.448"></a> -<span class="sourceLineNo">449</span> * Called before checkAndPut.<a name="line.449"></a> -<span class="sourceLineNo">450</span> * <p><a name="line.450"></a> -<span class="sourceLineNo">451</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.451"></a> -<span class="sourceLineNo">452</span> * <p><a name="line.452"></a> -<span class="sourceLineNo">453</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.453"></a> -<span class="sourceLineNo">454</span> * coprocessors<a name="line.454"></a> -<span class="sourceLineNo">455</span> * <p><a name="line.455"></a> -<span class="sourceLineNo">456</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.456"></a> -<span class="sourceLineNo">457</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.457"></a> -<span class="sourceLineNo">458</span> * @param c the environment provided by the region server<a name="line.458"></a> -<span class="sourceLineNo">459</span> * @param row row to check<a name="line.459"></a> -<span class="sourceLineNo">460</span> * @param family column family<a name="line.460"></a> -<span class="sourceLineNo">461</span> * @param qualifier column qualifier<a name="line.461"></a> -<span class="sourceLineNo">462</span> * @param op the comparison operation<a name="line.462"></a> -<span class="sourceLineNo">463</span> * @param comparator the comparator<a name="line.463"></a> -<span class="sourceLineNo">464</span> * @param put data to put if check succeeds<a name="line.464"></a> -<span class="sourceLineNo">465</span> * @param result<a name="line.465"></a> -<span class="sourceLineNo">466</span> * @return the return value to return to client if bypassing default<a name="line.466"></a> -<span class="sourceLineNo">467</span> * processing<a name="line.467"></a> -<span class="sourceLineNo">468</span> */<a name="line.468"></a> -<span class="sourceLineNo">469</span> default boolean preCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c, byte[] row,<a name="line.469"></a> -<span class="sourceLineNo">470</span> byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Put put,<a name="line.470"></a> -<span class="sourceLineNo">471</span> boolean result) throws IOException {<a name="line.471"></a> -<span class="sourceLineNo">472</span> return result;<a name="line.472"></a> -<span class="sourceLineNo">473</span> }<a name="line.473"></a> -<span class="sourceLineNo">474</span><a name="line.474"></a> -<span class="sourceLineNo">475</span> /**<a name="line.475"></a> -<span class="sourceLineNo">476</span> * Called before checkAndPut but after acquiring rowlock.<a name="line.476"></a> +<span class="sourceLineNo">161</span> * @throws IOException if an error occurred on the coprocessor<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> default void postFlush(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.163"></a> +<span class="sourceLineNo">164</span> FlushLifeCycleTracker tracker) throws IOException {}<a name="line.164"></a> +<span class="sourceLineNo">165</span><a name="line.165"></a> +<span class="sourceLineNo">166</span> /**<a name="line.166"></a> +<span class="sourceLineNo">167</span> * Called after a Store's memstore is flushed to disk.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param c the environment provided by the region server<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param store the store being flushed<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @param resultFile the new store file written out during compaction<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.171"></a> +<span class="sourceLineNo">172</span> */<a name="line.172"></a> +<span class="sourceLineNo">173</span> default void postFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.173"></a> +<span class="sourceLineNo">174</span> StoreFile resultFile, FlushLifeCycleTracker tracker) throws IOException {}<a name="line.174"></a> +<span class="sourceLineNo">175</span><a name="line.175"></a> +<span class="sourceLineNo">176</span> /**<a name="line.176"></a> +<span class="sourceLineNo">177</span> * Called prior to selecting the {@link StoreFile StoreFiles} to compact from the list of<a name="line.177"></a> +<span class="sourceLineNo">178</span> * available candidates. To alter the files used for compaction, you may mutate the passed in list<a name="line.178"></a> +<span class="sourceLineNo">179</span> * of candidates. If you remove all the candidates then the compaction will be canceled.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @param c the environment provided by the region server<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @param store the store where compaction is being requested<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param candidates the store files currently available for compaction<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.183"></a> +<span class="sourceLineNo">184</span> */<a name="line.184"></a> +<span class="sourceLineNo">185</span> default void preCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.185"></a> +<span class="sourceLineNo">186</span> List<? extends StoreFile> candidates, CompactionLifeCycleTracker tracker)<a name="line.186"></a> +<span class="sourceLineNo">187</span> throws IOException {}<a name="line.187"></a> +<span class="sourceLineNo">188</span><a name="line.188"></a> +<span class="sourceLineNo">189</span> /**<a name="line.189"></a> +<span class="sourceLineNo">190</span> * Called after the {@link StoreFile}s to compact have been selected from the available<a name="line.190"></a> +<span class="sourceLineNo">191</span> * candidates.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param c the environment provided by the region server<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param store the store being compacted<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param selected the store files selected to compact<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @param request the requested compaction<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> default void postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.198"></a> +<span class="sourceLineNo">199</span> List<? extends StoreFile> selected, CompactionLifeCycleTracker tracker,<a name="line.199"></a> +<span class="sourceLineNo">200</span> CompactionRequest request) {}<a name="line.200"></a> +<span class="sourceLineNo">201</span><a name="line.201"></a> +<span class="sourceLineNo">202</span> /**<a name="line.202"></a> +<span class="sourceLineNo">203</span> * Called before we open store scanner for compaction. You can use the {@code options} to change max<a name="line.203"></a> +<span class="sourceLineNo">204</span> * versions and TTL for the scanner being opened.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @param c the environment provided by the region server<a name="line.205"></a> +<span class="sourceLineNo">206</span> * @param store the store being compacted<a name="line.206"></a> +<span class="sourceLineNo">207</span> * @param scanType type of Scan<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @param options used to change max versions and TTL for the scanner being opened<a name="line.208"></a> +<span class="sourceLineNo">209</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.209"></a> +<span class="sourceLineNo">210</span> * @param request the requested compaction<a name="line.210"></a> +<span class="sourceLineNo">211</span> */<a name="line.211"></a> +<span class="sourceLineNo">212</span> default void preCompactScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.212"></a> +<span class="sourceLineNo">213</span> ScanType scanType, ScanOptions options, CompactionLifeCycleTracker tracker,<a name="line.213"></a> +<span class="sourceLineNo">214</span> CompactionRequest request) throws IOException {}<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> /**<a name="line.216"></a> +<span class="sourceLineNo">217</span> * Called prior to writing the {@link StoreFile}s selected for compaction into a new<a name="line.217"></a> +<span class="sourceLineNo">218</span> * {@code StoreFile}.<a name="line.218"></a> +<span class="sourceLineNo">219</span> * <p><a name="line.219"></a> +<span class="sourceLineNo">220</span> * To override or modify the compaction process, implementing classes can wrap the provided<a name="line.220"></a> +<span class="sourceLineNo">221</span> * {@link InternalScanner} with a custom implementation that is returned from this method. The<a name="line.221"></a> +<span class="sourceLineNo">222</span> * custom scanner can then inspect {@link org.apache.hadoop.hbase.Cell}s from the wrapped scanner,<a name="line.222"></a> +<span class="sourceLineNo">223</span> * applying its own policy to what gets written.<a name="line.223"></a> +<span class="sourceLineNo">224</span> * @param c the environment provided by the region server<a name="line.224"></a> +<span class="sourceLineNo">225</span> * @param store the store being compacted<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @param scanner the scanner over existing data used in the store file rewriting<a name="line.226"></a> +<span class="sourceLineNo">227</span> * @param scanType type of Scan<a name="line.227"></a> +<span class="sourceLineNo">228</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @param request the requested compaction<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @return the scanner to use during compaction. Should not be {@code null} unless the<a name="line.230"></a> +<span class="sourceLineNo">231</span> * implementation is writing new store files on its own.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> default InternalScanner preCompact(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.233"></a> +<span class="sourceLineNo">234</span> InternalScanner scanner, ScanType scanType, CompactionLifeCycleTracker tracker,<a name="line.234"></a> +<span class="sourceLineNo">235</span> CompactionRequest request) throws IOException {<a name="line.235"></a> +<span class="sourceLineNo">236</span> return scanner;<a name="line.236"></a> +<span class="sourceLineNo">237</span> }<a name="line.237"></a> +<span class="sourceLineNo">238</span><a name="line.238"></a> +<span class="sourceLineNo">239</span> /**<a name="line.239"></a> +<span class="sourceLineNo">240</span> * Called after compaction has completed and the new store file has been moved in to place.<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @param c the environment provided by the region server<a name="line.241"></a> +<span class="sourceLineNo">242</span> * @param store the store being compacted<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @param resultFile the new store file written out during compaction<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @param tracker used to track the life cycle of a compaction<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @param request the requested compaction<a name="line.245"></a> +<span class="sourceLineNo">246</span> */<a name="line.246"></a> +<span class="sourceLineNo">247</span> default void postCompact(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.247"></a> +<span class="sourceLineNo">248</span> StoreFile resultFile, CompactionLifeCycleTracker tracker, CompactionRequest request)<a name="line.248"></a> +<span class="sourceLineNo">249</span> throws IOException {}<a name="line.249"></a> +<span class="sourceLineNo">250</span><a name="line.250"></a> +<span class="sourceLineNo">251</span> /**<a name="line.251"></a> +<span class="sourceLineNo">252</span> * Called before the region is reported as closed to the master.<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @param c the environment provided by the region server<a name="line.253"></a> +<span class="sourceLineNo">254</span> * @param abortRequested true if the region server is aborting<a name="line.254"></a> +<span class="sourceLineNo">255</span> */<a name="line.255"></a> +<span class="sourceLineNo">256</span> default void preClose(ObserverContext<RegionCoprocessorEnvironment> c, boolean abortRequested)<a name="line.256"></a> +<span class="sourceLineNo">257</span> throws IOException {}<a name="line.257"></a> +<span class="sourceLineNo">258</span><a name="line.258"></a> +<span class="sourceLineNo">259</span> /**<a name="line.259"></a> +<span class="sourceLineNo">260</span> * Called after the region is reported as closed to the master.<a name="line.260"></a> +<span class="sourceLineNo">261</span> * @param c the environment provided by the region server<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @param abortRequested true if the region server is aborting<a name="line.262"></a> +<span class="sourceLineNo">263</span> */<a name="line.263"></a> +<span class="sourceLineNo">264</span> default void postClose(ObserverContext<RegionCoprocessorEnvironment> c, boolean abortRequested) {}<a name="line.264"></a> +<span class="sourceLineNo">265</span><a name="line.265"></a> +<span class="sourceLineNo">266</span> /**<a name="line.266"></a> +<span class="sourceLineNo">267</span> * Called before the client performs a Get<a name="line.267"></a> +<span class="sourceLineNo">268</span> * <p><a name="line.268"></a> +<span class="sourceLineNo">269</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.269"></a> +<span class="sourceLineNo">270</span> * <p><a name="line.270"></a> +<span class="sourceLineNo">271</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.271"></a> +<span class="sourceLineNo">272</span> * coprocessors<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @param c the environment provided by the region server<a name="line.273"></a> +<span class="sourceLineNo">274</span> * @param get the Get request<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @param result The result to return to the client if default processing<a name="line.275"></a> +<span class="sourceLineNo">276</span> * is bypassed. Can be modified. Will not be used if default processing<a name="line.276"></a> +<span class="sourceLineNo">277</span> * is not bypassed.<a name="line.277"></a> +<span class="sourceLineNo">278</span> */<a name="line.278"></a> +<span class="sourceLineNo">279</span> default void preGetOp(ObserverContext<RegionCoprocessorEnvironment> c, Get get, List<Cell> result)<a name="line.279"></a> +<span class="sourceLineNo">280</span> throws IOException {}<a name="line.280"></a> +<span class="sourceLineNo">281</span><a name="line.281"></a> +<span class="sourceLineNo">282</span> /**<a name="line.282"></a> +<span class="sourceLineNo">283</span> * Called after the client performs a Get<a name="line.283"></a> +<span class="sourceLineNo">284</span> * <p><a name="line.284"></a> +<span class="sourceLineNo">285</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.285"></a> +<span class="sourceLineNo">286</span> * coprocessors<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <p><a name="line.287"></a> +<span class="sourceLineNo">288</span> * Note: Do not retain references to any Cells in 'result' beyond the life of this invocation.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @param c the environment provided by the region server<a name="line.290"></a> +<span class="sourceLineNo">291</span> * @param get the Get request<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @param result the result to return to the client, modify as necessary<a name="line.292"></a> +<span class="sourceLineNo">293</span> */<a name="line.293"></a> +<span class="sourceLineNo">294</span> default void postGetOp(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.294"></a> +<span class="sourceLineNo">295</span> List<Cell> result) throws IOException {}<a name="line.295"></a> +<span class="sourceLineNo">296</span><a name="line.296"></a> +<span class="sourceLineNo">297</span> /**<a name="line.297"></a> +<span class="sourceLineNo">298</span> * Called before the client tests for existence using a Get.<a name="line.298"></a> +<span class="sourceLineNo">299</span> * <p><a name="line.299"></a> +<span class="sourceLineNo">300</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.300"></a> +<span class="sourceLineNo">301</span> * <p><a name="line.301"></a> +<span class="sourceLineNo">302</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.302"></a> +<span class="sourceLineNo">303</span> * coprocessors<a name="line.303"></a> +<span class="sourceLineNo">304</span> * @param c the environment provided by the region server<a name="line.304"></a> +<span class="sourceLineNo">305</span> * @param get the Get request<a name="line.305"></a> +<span class="sourceLineNo">306</span> * @param exists the result returned by the region server<a name="line.306"></a> +<span class="sourceLineNo">307</span> * @return the value to return to the client if bypassing default processing<a name="line.307"></a> +<span class="sourceLineNo">308</span> */<a name="line.308"></a> +<span class="sourceLineNo">309</span> default boolean preExists(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.309"></a> +<span class="sourceLineNo">310</span> boolean exists) throws IOException {<a name="line.310"></a> +<span class="sourceLineNo">311</span> return exists;<a name="line.311"></a> +<span class="sourceLineNo">312</span> }<a name="line.312"></a> +<span class="sourceLineNo">313</span><a name="line.313"></a> +<span class="sourceLineNo">314</span> /**<a name="line.314"></a> +<span class="sourceLineNo">315</span> * Called after the client tests for existence using a Get.<a name="line.315"></a> +<span class="sourceLineNo">316</span> * <p><a name="line.316"></a> +<span class="sourceLineNo">317</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.317"></a> +<span class="sourceLineNo">318</span> * coprocessors<a name="line.318"></a> +<span class="sourceLineNo">319</span> * @param c the environment provided by the region server<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @param get the Get request<a name="line.320"></a> +<span class="sourceLineNo">321</span> * @param exists the result returned by the region server<a name="line.321"></a> +<span class="sourceLineNo">322</span> * @return the result to return to the client<a name="line.322"></a> +<span class="sourceLineNo">323</span> */<a name="line.323"></a> +<span class="sourceLineNo">324</span> default boolean postExists(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.324"></a> +<span class="sourceLineNo">325</span> boolean exists) throws IOException {<a name="line.325"></a> +<span class="sourceLineNo">326</span> return exists;<a name="line.326"></a> +<span class="sourceLineNo">327</span> }<a name="line.327"></a> +<span class="sourceLineNo">328</span><a name="line.328"></a> +<span class="sourceLineNo">329</span> /**<a name="line.329"></a> +<span class="sourceLineNo">330</span> * Called before the client stores a value.<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <p><a name="line.331"></a> +<span class="sourceLineNo">332</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.332"></a> +<span class="sourceLineNo">333</span> * <p><a name="line.333"></a> +<span class="sourceLineNo">334</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.334"></a> +<span class="sourceLineNo">335</span> * coprocessors<a name="line.335"></a> +<span class="sourceLineNo">336</span> * <p><a name="line.336"></a> +<span class="sourceLineNo">337</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.337"></a> +<span class="sourceLineNo">338</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.338"></a> +<span class="sourceLineNo">339</span> * @param c the environment provided by the region server<a name="line.339"></a> +<span class="sourceLineNo">340</span> * @param put The Put object<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @param edit The WALEdit object that will be written to the wal<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @param durability Persistence guarantee for this Put<a name="line.342"></a> +<span class="sourceLineNo">343</span> */<a name="line.343"></a> +<span class="sourceLineNo">344</span> default void prePut(ObserverContext<RegionCoprocessorEnvironment> c, Put put, WALEdit edit,<a name="line.344"></a> +<span class="sourceLineNo">345</span> Durability durability) throws IOException {}<a name="line.345"></a> +<span class="sourceLineNo">346</span><a name="line.346"></a> +<span class="sourceLineNo">347</span> /**<a name="line.347"></a> +<span class="sourceLineNo">348</span> * Called after the client stores a value.<a name="line.348"></a> +<span class="sourceLineNo">349</span> * <p><a name="line.349"></a> +<span class="sourceLineNo">350</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.350"></a> +<span class="sourceLineNo">351</span> * coprocessors<a name="line.351"></a> +<span class="sourceLineNo">352</span> * <p><a name="line.352"></a> +<span class="sourceLineNo">353</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.353"></a> +<span class="sourceLineNo">354</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @param c the environment provided by the region server<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @param put The Put object<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @param edit The WALEdit object for the wal<a name="line.357"></a> +<span class="sourceLineNo">358</span> * @param durability Persistence guarantee for this Put<a name="line.358"></a> +<span class="sourceLineNo">359</span> */<a name="line.359"></a> +<span class="sourceLineNo">360</span> default void postPut(ObserverContext<RegionCoprocessorEnvironment> c, Put put, WALEdit edit,<a name="line.360"></a> +<span class="sourceLineNo">361</span> Durability durability) throws IOException {}<a name="line.361"></a> +<span class="sourceLineNo">362</span><a name="line.362"></a> +<span class="sourceLineNo">363</span> /**<a name="line.363"></a> +<span class="sourceLineNo">364</span> * Called before the client deletes a value.<a name="line.364"></a> +<span class="sourceLineNo">365</span> * <p><a name="line.365"></a> +<span class="sourceLineNo">366</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.366"></a> +<span class="sourceLineNo">367</span> * <p><a name="line.367"></a> +<span class="sourceLineNo">368</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.368"></a> +<span class="sourceLineNo">369</span> * coprocessors<a name="line.369"></a> +<span class="sourceLineNo">370</span> * <p><a name="line.370"></a> +<span class="sourceLineNo">371</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.371"></a> +<span class="sourceLineNo">372</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.372"></a> +<span class="sourceLineNo">373</span> * @param c the environment provided by the region server<a name="line.373"></a> +<span class="sourceLineNo">374</span> * @param delete The Delete object<a name="line.374"></a> +<span class="sourceLineNo">375</span> * @param edit The WALEdit object for the wal<a name="line.375"></a> +<span class="sourceLineNo">376</span> * @param durability Persistence guarantee for this Delete<a name="line.376"></a> +<span class="sourceLineNo">377</span> */<a name="line.377"></a> +<span class="sourceLineNo">378</span> default void preDelete(ObserverContext<RegionCoprocessorEnvironment> c, Delete delete,<a name="line.378"></a> +<span class="sourceLineNo">379</span> WALEdit edit, Durability durability) throws IOException {}<a name="line.379"></a> +<span class="sourceLineNo">380</span><a name="line.380"></a> +<span class="sourceLineNo">381</span> /**<a name="line.381"></a> +<span class="sourceLineNo">382</span> * Called before the server updates the timestamp for version delete with latest timestamp.<a name="line.382"></a> +<span class="sourceLineNo">383</span> * <p><a name="line.383"></a> +<span class="sourceLineNo">384</span> * Call CoprocessorEnvironment#bypass to skip default actions<a name="line.384"></a> +<span class="sourceLineNo">385</span> * <p><a name="line.385"></a> +<span class="sourceLineNo">386</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors<a name="line.386"></a> +<span class="sourceLineNo">387</span> * @param c the environment provided by the region server<a name="line.387"></a> +<span class="sourceLineNo">388</span> * @param mutation - the parent mutation associated with this delete cell<a name="line.388"></a> +<span class="sourceLineNo">389</span> * @param cell - The deleteColumn with latest version cell<a name="line.389"></a> +<span class="sourceLineNo">390</span> * @param byteNow - timestamp bytes<a name="line.390"></a> +<span class="sourceLineNo">391</span> * @param get - the get formed using the current cell's row. Note that the get does not specify<a name="line.391"></a> +<span class="sourceLineNo">392</span> * the family and qualifier<a name="line.392"></a> +<span class="sourceLineNo">393</span> */<a name="line.393"></a> +<span class="sourceLineNo">394</span> default void prePrepareTimeStampForDeleteVersion(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.394"></a> +<span class="sourceLineNo">395</span> Mutation mutation, Cell cell, byte[] byteNow, Get get) throws IOException {}<a name="line.395"></a> +<span class="sourceLineNo">396</span><a name="line.396"></a> +<span class="sourceLineNo">397</span> /**<a name="line.397"></a> +<span class="sourceLineNo">398</span> * Called after the client deletes a value.<a name="line.398"></a> +<span class="sourceLineNo">399</span> * <p><a name="line.399"></a> +<span class="sourceLineNo">400</span> * Call CoprocessorEnvironment#complete to skip any subsequent chained<a name="line.400"></a> +<span class="sourceLineNo">401</span> * coprocessors<a name="line.401"></a> +<span class="sourceLineNo">402</span> * <p><a name="line.402"></a> +<span class="sourceLineNo">403</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.403"></a> +<span class="sourceLineNo">404</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.404"></a> +<span class="sourceLineNo">405</span> * @param c the environment provided by the region server<a name="line.405"></a> +<span class="sourceLineNo">406</span> * @param delete The Delete object<a name="line.406"></a> +<span class="sourceLineNo">407</span> * @param edit The WALEdit object for the wal<a name="line.407"></a> +<span class="sourceLineNo">408</span> * @param durability Persistence guarantee for this Delete<a name="line.408"></a> +<span class="sourceLineNo">409</span> */<a name="line.409"></a> +<span class="sourceLineNo">410</span> default void postDelete(ObserverContext<RegionCoprocessorEnvironment> c, Delete delete,<a name="line.410"></a> +<span class="sourceLineNo">411</span> WALEdit edit, Durability durability) throws IOException {}<a name="line.411"></a> +<span class="sourceLineNo">412</span><a name="line.412"></a> +<span class="sourceLineNo">413</span> /**<a name="line.413"></a> +<span class="sourceLineNo">414</span> * This will be called for every batch mutation operation happening at the server. This will be<a name="line.414"></a> +<span class="sourceLineNo">415</span> * called after acquiring the locks on the mutating rows and after applying the proper timestamp<a name="line.415"></a> +<span class="sourceLineNo">416</span> * for each Mutation at the server. The batch may contain Put/Delete. By setting OperationStatus<a name="line.416"></a> +<span class="sourceLineNo">417</span> * of Mutations ({@link MiniBatchOperationInProgress#setOperationStatus(int, OperationStatus)}),<a name="line.417"></a> +<span class="sourceLineNo">418</span> * {@link RegionObserver} can make Region to skip these Mutations.<a name="line.418"></a> +<span class="sourceLineNo">419</span> * <p><a name="line.419"></a> +<span class="sourceLineNo">420</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.420"></a> +<span class="sourceLineNo">421</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.421"></a> +<span class="sourceLineNo">422</span> * @param c the environment provided by the region server<a name="line.422"></a> +<span class="sourceLineNo">423</span> * @param miniBatchOp batch of Mutations getting applied to region.<a name="line.423"></a> +<span class="sourceLineNo">424</span> */<a name="line.424"></a> +<span class="sourceLineNo">425</span> default void preBatchMutate(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.425"></a> +<span class="sourceLineNo">426</span> MiniBatchOperationInProgress<Mutation> miniBatchOp) throws IOException {}<a name="line.426"></a> +<span class="sourceLineNo">427</span><a name="line.427"></a> +<span class="sourceLineNo">428</span> /**<a name="line.428"></a> +<span class="sourceLineNo">429</span> * This will be called after applying a batch of Mutations on a region. The Mutations are added to<a name="line.429"></a> +<span class="sourceLineNo">430</span> * memstore and WAL. The difference of this one with<a name="line.430"></a> +<span class="sourceLineNo">431</span> * {@link #postPut(ObserverContext, Put, WALEdit, Durability) }<a name="line.431"></a> +<span class="sourceLineNo">432</span> * and {@link #postDelete(ObserverContext, Delete, WALEdit, Durability) } is<a name="line.432"></a> +<span class="sourceLineNo">433</span> * this hook will be executed before the mvcc transaction completion.<a name="line.433"></a> +<span class="sourceLineNo">434</span> * <p><a name="line.434"></a> +<span class="sourceLineNo">435</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.435"></a> +<span class="sourceLineNo">436</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.436"></a> +<span class="sourceLineNo">437</span> * @param c the environment provided by the region server<a name="line.437"></a> +<span class="sourceLineNo">438</span> * @param miniBatchOp batch of Mutations applied to region.<a name="line.438"></a> +<span class="sourceLineNo">439</span> */<a name="line.439"></a> +<span class="sourceLineNo">440</span> default void postBatchMutate(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.440"></a> +<span class="sourceLineNo">441</span> MiniBatchOperationInProgress<Mutation> miniBatchOp) throws IOException {}<a name="line.441"></a> +<span class="sourceLineNo">442</span><a name="line.442"></a> +<span class="sourceLineNo">443</span> /**<a name="line.443"></a> +<span class="sourceLineNo">444</span> * This will be called for region operations where read lock is acquired in<a name="line.444"></a> +<span class="sourceLineNo">445</span> * {@link Region#startRegionOperation()}.<a name="line.445"></a> +<span class="sourceLineNo">446</span> * @param ctx<a name="line.446"></a> +<span class="sourceLineNo">447</span> * @param operation The operation is about to be taken on the region<a name="line.447"></a> +<span class="sourceLineNo">448</span> */<a name="line.448"></a> +<span class="sourceLineNo">449</span> default void postStartRegionOperation(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.449"></a> +<span
<TRUNCATED>