blob: fc018f4af2a6e84834046b04b1f5b897749c216f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Coprocessor (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.hadoop.hbase, interface: Coprocessor">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/Coprocessor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase</a></div>
<h1 title="Interface Coprocessor" class="title">Interface Coprocessor</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="coprocessor/MasterCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessor</a></code>, <code><a href="coprocessor/RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></code>, <code><a href="coprocessor/RegionServerCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionServerCoprocessor</a></code>, <code><a href="coprocessor/WALCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">WALCoprocessor</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="security/access/AccessController.html" title="class in org.apache.hadoop.hbase.security.access">AccessController</a></code>, <code><a href="backup/BackupObserver.html" title="class in org.apache.hadoop.hbase.backup">BackupObserver</a></code>, <code><a href="coprocessor/example/BulkDeleteEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor.example">BulkDeleteEndpoint</a></code>, <code><a href="constraint/ConstraintProcessor.html" title="class in org.apache.hadoop.hbase.constraint">ConstraintProcessor</a></code>, <code><a href="security/access/CoprocessorWhitelistMasterObserver.html" title="class in org.apache.hadoop.hbase.security.access">CoprocessorWhitelistMasterObserver</a></code>, <code><a href="coprocessor/example/ExampleMasterObserverWithMetrics.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ExampleMasterObserverWithMetrics</a></code>, <code><a href="coprocessor/example/ExampleRegionObserverWithMetrics.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ExampleRegionObserverWithMetrics</a></code>, <code><a href="coprocessor/example/ExampleRegionObserverWithMetrics.ExampleRegionObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ExampleRegionObserverWithMetrics.ExampleRegionObserver</a></code>, <code><a href="JMXListener.html" title="class in org.apache.hadoop.hbase">JMXListener</a></code>, <code><a href="quotas/MasterQuotasObserver.html" title="class in org.apache.hadoop.hbase.quotas">MasterQuotasObserver</a></code>, <code><a href="coprocessor/MetaTableMetrics.html" title="class in org.apache.hadoop.hbase.coprocessor">MetaTableMetrics</a></code>, <code><a href="coprocessor/MetaTableMetrics.ExampleRegionObserverMeta.html" title="class in org.apache.hadoop.hbase.coprocessor">MetaTableMetrics.ExampleRegionObserverMeta</a></code>, <code><a href="coprocessor/MultiRowMutationEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor">MultiRowMutationEndpoint</a></code>, <code><a href="coprocessor/example/RefreshHFilesEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor.example">RefreshHFilesEndpoint</a></code>, <code><a href="replication/regionserver/ReplicationObserver.html" title="class in org.apache.hadoop.hbase.replication.regionserver">ReplicationObserver</a></code>, <code><a href="coprocessor/example/RowCountEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor.example">RowCountEndpoint</a></code>, <code><a href="rsgroup/RSGroupAdminEndpoint.html" title="class in org.apache.hadoop.hbase.rsgroup">RSGroupAdminEndpoint</a></code>, <code><a href="coprocessor/example/ScanModifyingObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ScanModifyingObserver</a></code>, <code><a href="security/access/SnapshotScannerHDFSAclController.html" title="class in org.apache.hadoop.hbase.security.access">SnapshotScannerHDFSAclController</a></code>, <code><a href="security/token/TokenProvider.html" title="class in org.apache.hadoop.hbase.security.token">TokenProvider</a></code>, <code><a href="coprocessor/example/ValueRewritingObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ValueRewritingObserver</a></code>, <code><a href="security/visibility/VisibilityController.html" title="class in org.apache.hadoop.hbase.security.visibility">VisibilityController</a></code>, <code><a href="security/visibility/VisibilityReplication.html" title="class in org.apache.hadoop.hbase.security.visibility">VisibilityReplication</a></code>, <code><a href="coprocessor/example/WriteHeavyIncrementObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">WriteHeavyIncrementObserver</a></code>, <code><a href="tool/WriteSinkCoprocessor.html" title="class in org.apache.hadoop.hbase.tool">WriteSinkCoprocessor</a></code>, <code><a href="coprocessor/example/ZooKeeperScanPolicyObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ZooKeeperScanPolicyObserver</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@LimitedPrivate("Coprocesssor")
@Evolving
</span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-57">Coprocessor</a></span></div>
<div class="block">Base interface for the 4 coprocessors - MasterCoprocessor, RegionCoprocessor,
RegionServerCoprocessor, and WALCoprocessor. Do NOT implement this interface directly. Unless an
implementation implements one (or more) of the above mentioned 4 coprocessors, it'll fail to be
loaded by any coprocessor host. Example: Building a coprocessor to observe Master operations.
<pre>
class MyMasterCoprocessor implements MasterCoprocessor {
&#64;Override
public Optional&lt;MasterObserver> getMasterObserver() {
return new MyMasterObserver();
}
}
class MyMasterObserver implements MasterObserver {
....
}
</pre>
Building a Service which can be loaded by both Master and RegionServer
<pre>
class MyCoprocessorService implements MasterCoprocessor, RegionServerCoprocessor {
&#64;Override
public Optional&lt;Service> getServices() {
return new ...;
}
}
</pre></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Coprocessor.State.html" class="type-name-link" title="enum class in org.apache.hadoop.hbase">Coprocessor.State</a></code></div>
<div class="col-last even-row-color">
<div class="block">Lifecycle state of a given coprocessor instance.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#PRIORITY_HIGHEST" class="member-name-link">PRIORITY_HIGHEST</a></code></div>
<div class="col-last even-row-color">
<div class="block">Highest installation priority</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#PRIORITY_LOWEST" class="member-name-link">PRIORITY_LOWEST</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Lowest installation priority</div>
</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#PRIORITY_SYSTEM" class="member-name-link">PRIORITY_SYSTEM</a></code></div>
<div class="col-last even-row-color">
<div class="block">High (system) installation priority</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#PRIORITY_USER" class="member-name-link">PRIORITY_USER</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Default installation priority for user coprocessors</div>
</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#VERSION" class="member-name-link">VERSION</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;org.apache.hbase.thirdparty.com.google.protobuf.Service&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getServices()" class="member-name-link">getServices</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Coprocessor endpoints providing protobuf services should override this method.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#start(org.apache.hadoop.hbase.CoprocessorEnvironment)" class="member-name-link">start</a><wbr>(<a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Called by the <a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own startup to initialize the
coprocessor.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)" class="member-name-link">stop</a><wbr>(<a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Called by the <a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the coprocessor.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="VERSION">
<h3>VERSION</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-60">VERSION</a></span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Coprocessor.VERSION">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="PRIORITY_HIGHEST">
<h3>PRIORITY_HIGHEST</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-63">PRIORITY_HIGHEST</a></span></div>
<div class="block">Highest installation priority</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Coprocessor.PRIORITY_HIGHEST">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="PRIORITY_SYSTEM">
<h3>PRIORITY_SYSTEM</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-65">PRIORITY_SYSTEM</a></span></div>
<div class="block">High (system) installation priority</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Coprocessor.PRIORITY_SYSTEM">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="PRIORITY_USER">
<h3>PRIORITY_USER</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-67">PRIORITY_USER</a></span></div>
<div class="block">Default installation priority for user coprocessors</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Coprocessor.PRIORITY_USER">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="PRIORITY_LOWEST">
<h3>PRIORITY_LOWEST</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-69">PRIORITY_LOWEST</a></span></div>
<div class="block">Lowest installation priority</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Coprocessor.PRIORITY_LOWEST">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="start(org.apache.hadoop.hbase.CoprocessorEnvironment)">
<h3>start</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-87">start</a></span><wbr><span class="parameters">(<a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Called by the <a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own startup to initialize the
coprocessor.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="stop(org.apache.hadoop.hbase.CoprocessorEnvironment)">
<h3>stop</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-93">stop</a></span><wbr><span class="parameters">(<a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Called by the <a href="CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the coprocessor.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getServices()">
<h3>getServices</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;org.apache.hbase.thirdparty.com.google.protobuf.Service&gt;</span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Coprocessor.html#line-101">getServices</a></span>()</div>
<div class="block">Coprocessor endpoints providing protobuf services should override this method.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Iterable of <code>Service</code>s or empty collection. Implementations should never return
null.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>