blob: 2320b6dd2528fe93ab39ca776b08e79f1f2fc671 [file] [log] [blame]
<!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: BulkLoadObserver">
<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.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">/**</span>
<span class="source-line-no">026</span><span id="line-26"> * Coprocessors implement this interface to observe and mediate bulk load operations. &lt;br&gt;</span>
<span class="source-line-no">027</span><span id="line-27"> * &lt;br&gt;</span>
<span class="source-line-no">028</span><span id="line-28"> * &lt;h3&gt;Exception Handling&lt;/h3&gt; For all functions, exception handling is done as follows:</span>
<span class="source-line-no">029</span><span id="line-29"> * &lt;ul&gt;</span>
<span class="source-line-no">030</span><span id="line-30"> * &lt;li&gt;Exceptions of type {@link IOException} are reported back to client.&lt;/li&gt;</span>
<span class="source-line-no">031</span><span id="line-31"> * &lt;li&gt;For any other kind of exception:</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;ul&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * &lt;li&gt;If the configuration {@link CoprocessorHost#ABORT_ON_ERROR_KEY} is set to true, then the</span>
<span class="source-line-no">034</span><span id="line-34"> * server aborts.&lt;/li&gt;</span>
<span class="source-line-no">035</span><span id="line-35"> * &lt;li&gt;Otherwise, coprocessor is removed from the server and</span>
<span class="source-line-no">036</span><span id="line-36"> * {@link org.apache.hadoop.hbase.DoNotRetryIOException} is returned to the client.&lt;/li&gt;</span>
<span class="source-line-no">037</span><span id="line-37"> * &lt;/ul&gt;</span>
<span class="source-line-no">038</span><span id="line-38"> * &lt;/li&gt;</span>
<span class="source-line-no">039</span><span id="line-39"> * &lt;/ul&gt;</span>
<span class="source-line-no">040</span><span id="line-40"> */</span>
<span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span>
<span class="source-line-no">042</span><span id="line-42">@InterfaceStability.Evolving</span>
<span class="source-line-no">043</span><span id="line-43">public interface BulkLoadObserver {</span>
<span class="source-line-no">044</span><span id="line-44"> /**</span>
<span class="source-line-no">045</span><span id="line-45"> * Called as part of SecureBulkLoadEndpoint.prepareBulkLoad() RPC call. It can't bypass the</span>
<span class="source-line-no">046</span><span id="line-46"> * default action, e.g., ctx.bypass() won't have effect. If you need to get the region or table</span>
<span class="source-line-no">047</span><span id="line-47"> * name, get it from the &lt;code&gt;ctx&lt;/code&gt; as follows:</span>
<span class="source-line-no">048</span><span id="line-48"> * &lt;code&gt;code&gt;ctx.getEnvironment().getRegion()&lt;/code&gt;. Use getRegionInfo to fetch the encodedName</span>
<span class="source-line-no">049</span><span id="line-49"> * and use getDescriptor() to get the tableName.</span>
<span class="source-line-no">050</span><span id="line-50"> * @param ctx the environment to interact with the framework and master</span>
<span class="source-line-no">051</span><span id="line-51"> */</span>
<span class="source-line-no">052</span><span id="line-52"> default void prePrepareBulkLoad(ObserverContext&lt;RegionCoprocessorEnvironment&gt; ctx)</span>
<span class="source-line-no">053</span><span id="line-53"> throws IOException {</span>
<span class="source-line-no">054</span><span id="line-54"> }</span>
<span class="source-line-no">055</span><span id="line-55"></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 as part of SecureBulkLoadEndpoint.cleanupBulkLoad() RPC call. It can't bypass the</span>
<span class="source-line-no">058</span><span id="line-58"> * default action, e.g., ctx.bypass() won't have effect. If you need to get the region or table</span>
<span class="source-line-no">059</span><span id="line-59"> * name, get it from the &lt;code&gt;ctx&lt;/code&gt; as follows:</span>
<span class="source-line-no">060</span><span id="line-60"> * &lt;code&gt;code&gt;ctx.getEnvironment().getRegion()&lt;/code&gt;. Use getRegionInfo to fetch the encodedName</span>
<span class="source-line-no">061</span><span id="line-61"> * and use getDescriptor() to get the tableName.</span>
<span class="source-line-no">062</span><span id="line-62"> * @param ctx the environment to interact with the framework and master</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> default void preCleanupBulkLoad(ObserverContext&lt;RegionCoprocessorEnvironment&gt; ctx)</span>
<span class="source-line-no">065</span><span id="line-65"> throws IOException {</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67">}</span>
</pre>
</div>
</main>
</body>
</html>