| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.coprocessor, interface: RegionServerObserver"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.coprocessor;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.CacheEvictionStats;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.Mutation;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.replication.ReplicationEndpoint;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">/**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * Defines coprocessor hooks for interacting with operations on the</span> |
| <span class="source-line-no">033</span><span id="line-33"> * {@link org.apache.hadoop.hbase.regionserver.HRegionServer} process. Since most implementations</span> |
| <span class="source-line-no">034</span><span id="line-34"> * will be interested in only a subset of hooks, this class uses 'default' functions to avoid having</span> |
| <span class="source-line-no">035</span><span id="line-35"> * to add unnecessary overrides. When the functions are non-empty, it's simply to satisfy the</span> |
| <span class="source-line-no">036</span><span id="line-36"> * compiler by returning value of expected (non-void) type. It is done in a way that these default</span> |
| <span class="source-line-no">037</span><span id="line-37"> * definitions act as no-op. So our suggestion to implementation would be to not call these</span> |
| <span class="source-line-no">038</span><span id="line-38"> * 'default' methods from overrides. <br></span> |
| <span class="source-line-no">039</span><span id="line-39"> * <br></span> |
| <span class="source-line-no">040</span><span id="line-40"> * <h3>Exception Handling</h3> For all functions, exception handling is done as follows:</span> |
| <span class="source-line-no">041</span><span id="line-41"> * <ul></span> |
| <span class="source-line-no">042</span><span id="line-42"> * <li>Exceptions of type {@link IOException} are reported back to client.</li></span> |
| <span class="source-line-no">043</span><span id="line-43"> * <li>For any other kind of exception:</span> |
| <span class="source-line-no">044</span><span id="line-44"> * <ul></span> |
| <span class="source-line-no">045</span><span id="line-45"> * <li>If the configuration {@link CoprocessorHost#ABORT_ON_ERROR_KEY} is set to true, then the</span> |
| <span class="source-line-no">046</span><span id="line-46"> * server aborts.</li></span> |
| <span class="source-line-no">047</span><span id="line-47"> * <li>Otherwise, coprocessor is removed from the server and</span> |
| <span class="source-line-no">048</span><span id="line-48"> * {@link org.apache.hadoop.hbase.DoNotRetryIOException} is returned to the client.</li></span> |
| <span class="source-line-no">049</span><span id="line-49"> * </ul></span> |
| <span class="source-line-no">050</span><span id="line-50"> * </li></span> |
| <span class="source-line-no">051</span><span id="line-51"> * </ul></span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span> |
| <span class="source-line-no">054</span><span id="line-54">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">055</span><span id="line-55">public interface RegionServerObserver {</span> |
| <span class="source-line-no">056</span><span id="line-56"> /**</span> |
| <span class="source-line-no">057</span><span id="line-57"> * Called before stopping region server.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> default void preStopRegionServer(final ObserverContext<RegionServerCoprocessorEnvironment> ctx)</span> |
| <span class="source-line-no">061</span><span id="line-61"> throws IOException {</span> |
| <span class="source-line-no">062</span><span id="line-62"> }</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * This will be called before executing user request to roll a region server WAL.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> default void preRollWALWriterRequest(</span> |
| <span class="source-line-no">069</span><span id="line-69"> final ObserverContext<RegionServerCoprocessorEnvironment> ctx) throws IOException {</span> |
| <span class="source-line-no">070</span><span id="line-70"> }</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * This will be called after executing user request to roll a region server WAL.</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> default void postRollWALWriterRequest(</span> |
| <span class="source-line-no">077</span><span id="line-77"> final ObserverContext<RegionServerCoprocessorEnvironment> ctx) throws IOException {</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * This will be called after the replication endpoint is instantiated.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @param endpoint - the base endpoint for replication</span> |
| <span class="source-line-no">084</span><span id="line-84"> * @return the endpoint to use during replication.</span> |
| <span class="source-line-no">085</span><span id="line-85"> */</span> |
| <span class="source-line-no">086</span><span id="line-86"> default ReplicationEndpoint postCreateReplicationEndPoint(</span> |
| <span class="source-line-no">087</span><span id="line-87"> ObserverContext<RegionServerCoprocessorEnvironment> ctx, ReplicationEndpoint endpoint) {</span> |
| <span class="source-line-no">088</span><span id="line-88"> return endpoint;</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> // TODO remove below 2 hooks when we implement AC as a core impl than a CP impl.</span> |
| <span class="source-line-no">092</span><span id="line-92"> /**</span> |
| <span class="source-line-no">093</span><span id="line-93"> * This will be called before executing replication request to shipping log entries.</span> |
| <span class="source-line-no">094</span><span id="line-94"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @deprecated As of release 2.0.0 with out any replacement. This is maintained for internal usage</span> |
| <span class="source-line-no">096</span><span id="line-96"> * by AccessController. Do not use these hooks in custom co-processors.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> @Deprecated</span> |
| <span class="source-line-no">099</span><span id="line-99"> default void preReplicateLogEntries(final ObserverContext<RegionServerCoprocessorEnvironment> ctx)</span> |
| <span class="source-line-no">100</span><span id="line-100"> throws IOException {</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> /**</span> |
| <span class="source-line-no">104</span><span id="line-104"> * This will be called after executing replication request to shipping log entries.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @deprecated As of release 2.0.0 with out any replacement. This is maintained for internal usage</span> |
| <span class="source-line-no">107</span><span id="line-107"> * by AccessController. Do not use these hooks in custom co-processors.</span> |
| <span class="source-line-no">108</span><span id="line-108"> */</span> |
| <span class="source-line-no">109</span><span id="line-109"> @Deprecated</span> |
| <span class="source-line-no">110</span><span id="line-110"> default void postReplicateLogEntries(</span> |
| <span class="source-line-no">111</span><span id="line-111"> final ObserverContext<RegionServerCoprocessorEnvironment> ctx) throws IOException {</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /**</span> |
| <span class="source-line-no">115</span><span id="line-115"> * This will be called before clearing compaction queues</span> |
| <span class="source-line-no">116</span><span id="line-116"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">117</span><span id="line-117"> */</span> |
| <span class="source-line-no">118</span><span id="line-118"> default void preClearCompactionQueues(</span> |
| <span class="source-line-no">119</span><span id="line-119"> final ObserverContext<RegionServerCoprocessorEnvironment> ctx) throws IOException {</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> /**</span> |
| <span class="source-line-no">123</span><span id="line-123"> * This will be called after clearing compaction queues</span> |
| <span class="source-line-no">124</span><span id="line-124"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">125</span><span id="line-125"> */</span> |
| <span class="source-line-no">126</span><span id="line-126"> default void postClearCompactionQueues(</span> |
| <span class="source-line-no">127</span><span id="line-127"> final ObserverContext<RegionServerCoprocessorEnvironment> ctx) throws IOException {</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> /**</span> |
| <span class="source-line-no">131</span><span id="line-131"> * This will be called before executing procedures</span> |
| <span class="source-line-no">132</span><span id="line-132"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">133</span><span id="line-133"> */</span> |
| <span class="source-line-no">134</span><span id="line-134"> default void preExecuteProcedures(ObserverContext<RegionServerCoprocessorEnvironment> ctx)</span> |
| <span class="source-line-no">135</span><span id="line-135"> throws IOException {</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> /**</span> |
| <span class="source-line-no">139</span><span id="line-139"> * This will be called after executing procedures</span> |
| <span class="source-line-no">140</span><span id="line-140"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">141</span><span id="line-141"> */</span> |
| <span class="source-line-no">142</span><span id="line-142"> default void postExecuteProcedures(ObserverContext<RegionServerCoprocessorEnvironment> ctx)</span> |
| <span class="source-line-no">143</span><span id="line-143"> throws IOException {</span> |
| <span class="source-line-no">144</span><span id="line-144"> }</span> |
| <span class="source-line-no">145</span><span id="line-145"></span> |
| <span class="source-line-no">146</span><span id="line-146"> /**</span> |
| <span class="source-line-no">147</span><span id="line-147"> * This will be called before replication sink mutations are executed on the sink table as part of</span> |
| <span class="source-line-no">148</span><span id="line-148"> * batch call.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">150</span><span id="line-150"> * @param walEntry wal entry from which mutation is formed.</span> |
| <span class="source-line-no">151</span><span id="line-151"> * @param mutation mutation to be applied at sink cluster.</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @throws IOException if something goes wrong.</span> |
| <span class="source-line-no">153</span><span id="line-153"> */</span> |
| <span class="source-line-no">154</span><span id="line-154"> default void preReplicationSinkBatchMutate(</span> |
| <span class="source-line-no">155</span><span id="line-155"> ObserverContext<RegionServerCoprocessorEnvironment> ctx, AdminProtos.WALEntry walEntry,</span> |
| <span class="source-line-no">156</span><span id="line-156"> Mutation mutation) throws IOException {</span> |
| <span class="source-line-no">157</span><span id="line-157"></span> |
| <span class="source-line-no">158</span><span id="line-158"> }</span> |
| <span class="source-line-no">159</span><span id="line-159"></span> |
| <span class="source-line-no">160</span><span id="line-160"> /**</span> |
| <span class="source-line-no">161</span><span id="line-161"> * This will be called after replication sink mutations are executed on the sink table as part of</span> |
| <span class="source-line-no">162</span><span id="line-162"> * batch call.</span> |
| <span class="source-line-no">163</span><span id="line-163"> * @param ctx the environment to interact with the framework and region server.</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @param walEntry wal entry from which mutation is formed.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @param mutation mutation to be applied at sink cluster.</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @throws IOException if something goes wrong.</span> |
| <span class="source-line-no">167</span><span id="line-167"> */</span> |
| <span class="source-line-no">168</span><span id="line-168"> default void postReplicationSinkBatchMutate(</span> |
| <span class="source-line-no">169</span><span id="line-169"> ObserverContext<RegionServerCoprocessorEnvironment> ctx, AdminProtos.WALEntry walEntry,</span> |
| <span class="source-line-no">170</span><span id="line-170"> Mutation mutation) throws IOException {</span> |
| <span class="source-line-no">171</span><span id="line-171"></span> |
| <span class="source-line-no">172</span><span id="line-172"> }</span> |
| <span class="source-line-no">173</span><span id="line-173"></span> |
| <span class="source-line-no">174</span><span id="line-174"> /**</span> |
| <span class="source-line-no">175</span><span id="line-175"> * Called before clearing the block caches for one or more regions</span> |
| <span class="source-line-no">176</span><span id="line-176"> * @param ctx the coprocessor instance's environment</span> |
| <span class="source-line-no">177</span><span id="line-177"> * @throws IOException if you need to signal an IO error</span> |
| <span class="source-line-no">178</span><span id="line-178"> */</span> |
| <span class="source-line-no">179</span><span id="line-179"> default void preClearRegionBlockCache(ObserverContext<RegionServerCoprocessorEnvironment> ctx)</span> |
| <span class="source-line-no">180</span><span id="line-180"> throws IOException {</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182"></span> |
| <span class="source-line-no">183</span><span id="line-183"> /**</span> |
| <span class="source-line-no">184</span><span id="line-184"> * Called after clearing the block caches for one or more regions</span> |
| <span class="source-line-no">185</span><span id="line-185"> * @param ctx the coprocessor instance's environment</span> |
| <span class="source-line-no">186</span><span id="line-186"> * @param stats statistics about the cache evictions that happened</span> |
| <span class="source-line-no">187</span><span id="line-187"> * @throws IOException if you need to signal an IO error</span> |
| <span class="source-line-no">188</span><span id="line-188"> */</span> |
| <span class="source-line-no">189</span><span id="line-189"> default void postClearRegionBlockCache(ObserverContext<RegionServerCoprocessorEnvironment> ctx,</span> |
| <span class="source-line-no">190</span><span id="line-190"> CacheEvictionStats stats) throws IOException {</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> /**</span> |
| <span class="source-line-no">194</span><span id="line-194"> * Called before reloading the RegionServer's {@link Configuration} from disk</span> |
| <span class="source-line-no">195</span><span id="line-195"> * @param ctx the coprocessor instance's environment</span> |
| <span class="source-line-no">196</span><span id="line-196"> * @param preReloadConf the {@link Configuration} in use prior to reload</span> |
| <span class="source-line-no">197</span><span id="line-197"> * @throws IOException if you need to signal an IO error</span> |
| <span class="source-line-no">198</span><span id="line-198"> */</span> |
| <span class="source-line-no">199</span><span id="line-199"> default void preUpdateRegionServerConfiguration(</span> |
| <span class="source-line-no">200</span><span id="line-200"> ObserverContext<RegionServerCoprocessorEnvironment> ctx, Configuration preReloadConf)</span> |
| <span class="source-line-no">201</span><span id="line-201"> throws IOException {</span> |
| <span class="source-line-no">202</span><span id="line-202"> }</span> |
| <span class="source-line-no">203</span><span id="line-203"></span> |
| <span class="source-line-no">204</span><span id="line-204"> /**</span> |
| <span class="source-line-no">205</span><span id="line-205"> * Called after reloading the RegionServer's {@link Configuration} from disk</span> |
| <span class="source-line-no">206</span><span id="line-206"> * @param ctx the coprocessor instance's environment</span> |
| <span class="source-line-no">207</span><span id="line-207"> * @param postReloadConf the {@link Configuration} that was loaded</span> |
| <span class="source-line-no">208</span><span id="line-208"> * @throws IOException if you need to signal an IO error</span> |
| <span class="source-line-no">209</span><span id="line-209"> */</span> |
| <span class="source-line-no">210</span><span id="line-210"> default void postUpdateRegionServerConfiguration(</span> |
| <span class="source-line-no">211</span><span id="line-211"> ObserverContext<RegionServerCoprocessorEnvironment> ctx, Configuration postReloadConf)</span> |
| <span class="source-line-no">212</span><span id="line-212"> throws IOException {</span> |
| <span class="source-line-no">213</span><span id="line-213"> }</span> |
| <span class="source-line-no">214</span><span id="line-214"></span> |
| <span class="source-line-no">215</span><span id="line-215">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
