| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CoprocessorHost (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.coprocessor, class: CoprocessorHost"> |
| <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/CoprocessorHost.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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.hadoop.hbase.coprocessor</a></div> |
| <h1 title="Class CoprocessorHost" class="title">Class CoprocessorHost<C extends <a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a>,<wbr>E extends <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a><C>></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.coprocessor.CoprocessorHost<C,<wbr>E></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>C</code> - type of specific coprocessor this host will handle</dd> |
| <dd><code>E</code> - type of specific coprocessor environment this host requires. provides</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../master/MasterCoprocessorHost.html" title="class in org.apache.hadoop.hbase.master">MasterCoprocessorHost</a></code>, <code><a href="../regionserver/RegionCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver">RegionCoprocessorHost</a></code>, <code><a href="../regionserver/RegionServerCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver">RegionServerCoprocessorHost</a></code>, <code><a href="../regionserver/wal/WALCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver.wal">WALCoprocessorHost</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public abstract class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-56">CoprocessorHost</a><C extends <a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a>,<wbr>E extends <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a><C>></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Provides the common setup framework and runtime services for coprocessor invocation from HBase |
| services.</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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>(package private) static class </code></div> |
| <div class="col-second even-row-color"><code><a href="CoprocessorHost.EnvironmentPriorityComparator.html" class="type-name-link" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.EnvironmentPriorityComparator</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Environment priority comparator.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="CoprocessorHost.ObserverGetter.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverGetter</a><<a href="CoprocessorHost.ObserverGetter.html" title="type parameter in CoprocessorHost.ObserverGetter">C</a>,<wbr><a href="CoprocessorHost.ObserverGetter.html" title="type parameter in CoprocessorHost.ObserverGetter">O</a>></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Implementations defined function to get an observer of type <code>O</code> from a coprocessor of |
| type <code>C</code>.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private class </code></div> |
| <div class="col-second even-row-color"><code><a href="CoprocessorHost.ObserverOperation.html" class="type-name-link" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverOperation</a><<a href="CoprocessorHost.ObserverOperation.html" title="type parameter in CoprocessorHost.ObserverOperation">O</a>></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>class </code></div> |
| <div class="col-second odd-row-color"><code><a href="CoprocessorHost.ObserverOperationWithoutResult.html" class="type-name-link" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverOperationWithoutResult</a><<a href="CoprocessorHost.ObserverOperationWithoutResult.html" title="type parameter in CoprocessorHost.ObserverOperationWithoutResult">O</a>></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="CoprocessorHost.ObserverOperationWithResult.html" class="type-name-link" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverOperationWithResult</a><<a href="CoprocessorHost.ObserverOperationWithResult.html" title="type parameter in CoprocessorHost.ObserverOperationWithResult">O</a>,<wbr><a href="CoprocessorHost.ObserverOperationWithResult.html" title="type parameter in CoprocessorHost.ObserverOperationWithResult">R</a>></code></div> |
| <div class="col-last even-row-color"> </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 <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#ABORT_ON_ERROR_KEY" class="member-name-link">ABORT_ON_ERROR_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#abortable" class="member-name-link">abortable</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second even-row-color"><code><a href="#conf" class="member-name-link">conf</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../util/SortedList.html" title="class in org.apache.hadoop.hbase.util">SortedList</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#coprocEnvironments" class="member-name-link">coprocEnvironments</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Ordered set of loaded coprocessors with lock</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#coprocessorNames" class="member-name-link">coprocessorNames</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Not to be confused with the per-object _coprocessors_ (above), coprocessorNames is static and |
| stores the set of all coprocessors ever loaded by any thread in this JVM.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#COPROCESSORS_ENABLED_CONF_KEY" class="member-name-link">COPROCESSORS_ENABLED_CONF_KEY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_ABORT_ON_ERROR" class="member-name-link">DEFAULT_ABORT_ON_ERROR</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_COPROCESSORS_ENABLED" class="member-name-link">DEFAULT_COPROCESSORS_ENABLED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR" class="member-name-link">DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_USER_COPROCESSORS_ENABLED" class="member-name-link">DEFAULT_USER_COPROCESSORS_ENABLED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a>>></code></div> |
| <div class="col-second even-row-color"><code><a href="#legacyWarning" class="member-name-link">legacyWarning</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Used to limit legacy handling to once per Coprocessor class per classloader.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicInteger.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicInteger</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#loadSequence" class="member-name-link">loadSequence</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#MASTER_COPROCESSOR_CONF_KEY" class="member-name-link">MASTER_COPROCESSOR_CONF_KEY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#pathPrefix" class="member-name-link">pathPrefix</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#REGION_COPROCESSOR_CONF_KEY" class="member-name-link">REGION_COPROCESSOR_CONF_KEY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#REGIONSERVER_COPROCESSOR_CONF_KEY" class="member-name-link">REGIONSERVER_COPROCESSOR_CONF_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR" class="member-name-link">SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#USER_COPROCESSORS_ENABLED_CONF_KEY" class="member-name-link">USER_COPROCESSORS_ENABLED_CONF_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#USER_REGION_COPROCESSOR_CONF_KEY" class="member-name-link">USER_REGION_COPROCESSOR_CONF_KEY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#WAL_COPROCESSOR_CONF_KEY" class="member-name-link">WAL_COPROCESSOR_CONF_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.Abortable)" class="member-name-link">CoprocessorHost</a><wbr>(<a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> abortable)</code></div> |
| <div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abortServer(E,java.lang.Throwable)" class="member-name-link">abortServer</a><wbr>(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> environment, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abortServer(java.lang.String,java.lang.Throwable)" class="member-name-link">abortServer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> coprocessorName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> e)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#checkAndGetInstance(java.lang.Class)" class="member-name-link">checkAndGetInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> implClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when a new Coprocessor class needs to be loaded.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkAndLoadInstance(java.lang.Class,int,org.apache.hadoop.conf.Configuration)" class="member-name-link">checkAndLoadInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> implClass, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createEnvironment(C,int,int,org.apache.hadoop.conf.Configuration)" class="member-name-link">createEnvironment</a><wbr>(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a> instance, |
| int priority, |
| int sequence, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when a new Coprocessor class is loaded</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <O> boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execOperation(org.apache.hadoop.hbase.coprocessor.CoprocessorHost.ObserverOperation)" class="member-name-link">execOperation</a><wbr>(<a href="CoprocessorHost.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>,<wbr><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>>.<a href="CoprocessorHost.ObserverOperation.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverOperation</a><O> observerOperation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <O,<wbr> |
| R> R</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execOperationWithResult(org.apache.hadoop.hbase.coprocessor.CoprocessorHost.ObserverOperationWithResult)" class="member-name-link">execOperationWithResult</a><wbr>(<a href="CoprocessorHost.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>,<wbr><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>>.<a href="CoprocessorHost.ObserverOperationWithResult.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverOperationWithResult</a><O,<wbr>R> observerOperation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Do not call with an observerOperation that is null! Have the caller check.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <O> boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execShutdown(org.apache.hadoop.hbase.coprocessor.CoprocessorHost.ObserverOperation)" class="member-name-link">execShutdown</a><wbr>(<a href="CoprocessorHost.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>,<wbr><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>>.<a href="CoprocessorHost.ObserverOperation.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverOperation</a><O> observerOperation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Coprocessor classes can be configured in any order, based on that priority is set and chained |
| in a sorted order.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>><br>T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findCoprocessor(java.lang.Class)" class="member-name-link">findCoprocessor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> cls)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findCoprocessor(java.lang.String)" class="member-name-link">findCoprocessor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Find coprocessors by full class name or simple name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findCoprocessorEnvironment(java.lang.String)" class="member-name-link">findCoprocessorEnvironment</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Find a coprocessor environment by class name</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>><br><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><T></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findCoprocessors(java.lang.Class)" class="member-name-link">findCoprocessors</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> cls)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Find list of coprocessors that extend/implement the given class/interface</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoprocessors()" class="member-name-link">getCoprocessors</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Used to create a parameter to the HServerLoad constructor so that HServerLoad can provide |
| information about the coprocessors loaded by this regionserver.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExternalClassLoaders()" class="member-name-link">getExternalClassLoaders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Retrieves the set of classloaders used to instantiate Coprocessor classes defined in external |
| jar files.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLoadedCoprocessors()" class="member-name-link">getLoadedCoprocessors</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handleCoprocessorThrowable(E,java.lang.Throwable)" class="member-name-link">handleCoprocessorThrowable</a><wbr>(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> env, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> e)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is used by coprocessor hooks which are declared to throw IOException (or its subtypes).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#load(java.lang.Class,int,org.apache.hadoop.conf.Configuration)" class="member-name-link">load</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>> implClass, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#load(org.apache.hadoop.fs.Path,java.lang.String,int,org.apache.hadoop.conf.Configuration)" class="member-name-link">load</a><wbr>(org.apache.hadoop.fs.Path path, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Load a coprocessor implementation into the host</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#load(org.apache.hadoop.fs.Path,java.lang.String,int,org.apache.hadoop.conf.Configuration,java.lang.String%5B%5D)" class="member-name-link">load</a><wbr>(org.apache.hadoop.fs.Path path, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] includedClassPrefixes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Load a coprocessor implementation into the host</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loadSystemCoprocessors(org.apache.hadoop.conf.Configuration,java.lang.String)" class="member-name-link">loadSystemCoprocessors</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> confKey)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Load system coprocessors once only.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdown(E)" class="member-name-link">shutdown</a><wbr>(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></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="REGION_COPROCESSOR_CONF_KEY"> |
| <h3>REGION_COPROCESSOR_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-58">REGION_COPROCESSOR_CONF_KEY</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.CoprocessorHost.REGION_COPROCESSOR_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REGIONSERVER_COPROCESSOR_CONF_KEY"> |
| <h3>REGIONSERVER_COPROCESSOR_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-59">REGIONSERVER_COPROCESSOR_CONF_KEY</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.CoprocessorHost.REGIONSERVER_COPROCESSOR_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="USER_REGION_COPROCESSOR_CONF_KEY"> |
| <h3>USER_REGION_COPROCESSOR_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-61">USER_REGION_COPROCESSOR_CONF_KEY</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.CoprocessorHost.USER_REGION_COPROCESSOR_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MASTER_COPROCESSOR_CONF_KEY"> |
| <h3>MASTER_COPROCESSOR_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-63">MASTER_COPROCESSOR_CONF_KEY</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.CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WAL_COPROCESSOR_CONF_KEY"> |
| <h3>WAL_COPROCESSOR_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-64">WAL_COPROCESSOR_CONF_KEY</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.CoprocessorHost.WAL_COPROCESSOR_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ABORT_ON_ERROR_KEY"> |
| <h3>ABORT_ON_ERROR_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-65">ABORT_ON_ERROR_KEY</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.CoprocessorHost.ABORT_ON_ERROR_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_ABORT_ON_ERROR"> |
| <h3>DEFAULT_ABORT_ON_ERROR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-66">DEFAULT_ABORT_ON_ERROR</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.CoprocessorHost.DEFAULT_ABORT_ON_ERROR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COPROCESSORS_ENABLED_CONF_KEY"> |
| <h3>COPROCESSORS_ENABLED_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-67">COPROCESSORS_ENABLED_CONF_KEY</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.CoprocessorHost.COPROCESSORS_ENABLED_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_COPROCESSORS_ENABLED"> |
| <h3>DEFAULT_COPROCESSORS_ENABLED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-68">DEFAULT_COPROCESSORS_ENABLED</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.CoprocessorHost.DEFAULT_COPROCESSORS_ENABLED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="USER_COPROCESSORS_ENABLED_CONF_KEY"> |
| <h3>USER_COPROCESSORS_ENABLED_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-69">USER_COPROCESSORS_ENABLED_CONF_KEY</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.CoprocessorHost.USER_COPROCESSORS_ENABLED_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_USER_COPROCESSORS_ENABLED"> |
| <h3>DEFAULT_USER_COPROCESSORS_ENABLED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-70">DEFAULT_USER_COPROCESSORS_ENABLED</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.CoprocessorHost.DEFAULT_USER_COPROCESSORS_ENABLED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR"> |
| <h3>SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-71">SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR</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.CoprocessorHost.SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR"> |
| <h3>DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-73">DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR</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.CoprocessorHost.DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-75">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abortable"> |
| <h3>abortable</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-76">abortable</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="coprocEnvironments"> |
| <h3>coprocEnvironments</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../util/SortedList.html" title="class in org.apache.hadoop.hbase.util">SortedList</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> extends <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-78">coprocEnvironments</a></span></div> |
| <div class="block">Ordered set of loaded coprocessors with lock</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conf"> |
| <h3>conf</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-80">conf</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="pathPrefix"> |
| <h3>pathPrefix</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-82">pathPrefix</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loadSequence"> |
| <h3>loadSequence</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicInteger.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicInteger</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-83">loadSequence</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="coprocessorNames"> |
| <h3>coprocessorNames</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-97">coprocessorNames</a></span></div> |
| <div class="block">Not to be confused with the per-object _coprocessors_ (above), coprocessorNames is static and |
| stores the set of all coprocessors ever loaded by any thread in this JVM. It is strictly |
| additive: coprocessors are added to coprocessorNames, by checkAndLoadInstance() but are never |
| removed, since the intention is to preserve a history of all loaded coprocessors for diagnosis |
| in case of server crash (HBASE-4014).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="legacyWarning"> |
| <h3>legacyWarning</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a>>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-482">legacyWarning</a></span></div> |
| <div class="block">Used to limit legacy handling to once per Coprocessor class per classloader.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.Abortable)"> |
| <h3>CoprocessorHost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-85">CoprocessorHost</a></span><wbr><span class="parameters">(<a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> abortable)</span></div> |
| </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="getLoadedCoprocessors()"> |
| <h3>getLoadedCoprocessors</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-99">getLoadedCoprocessors</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCoprocessors()"> |
| <h3>getCoprocessors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-110">getCoprocessors</a></span>()</div> |
| <div class="block">Used to create a parameter to the HServerLoad constructor so that HServerLoad can provide |
| information about the coprocessors loaded by this regionserver. (HBASE-4070: Improve region |
| server metrics to report loaded coprocessors to master).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loadSystemCoprocessors(org.apache.hadoop.conf.Configuration,java.lang.String)"> |
| <h3>loadSystemCoprocessors</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-122">loadSystemCoprocessors</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> confKey)</span></div> |
| <div class="block">Load system coprocessors once only. Read the class names from configuration. Called by |
| constructor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="load(org.apache.hadoop.fs.Path,java.lang.String,int,org.apache.hadoop.conf.Configuration)"> |
| <h3>load</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-194">load</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path path, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf)</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">Load a coprocessor implementation into the host</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - path to implementation jar</dd> |
| <dd><code>className</code> - the main class name</dd> |
| <dd><code>priority</code> - chaining priority</dd> |
| <dd><code>conf</code> - configuration for coprocessor</dd> |
| <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> - Exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="load(org.apache.hadoop.fs.Path,java.lang.String,int,org.apache.hadoop.conf.Configuration,java.lang.String[])"> |
| <h3>load</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-212">load</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path path, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] includedClassPrefixes)</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">Load a coprocessor implementation into the host</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - path to implementation jar</dd> |
| <dd><code>className</code> - the main class name</dd> |
| <dd><code>priority</code> - chaining priority</dd> |
| <dd><code>conf</code> - configuration for coprocessor</dd> |
| <dd><code>includedClassPrefixes</code> - class name prefixes to include</dd> |
| <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> - Exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="load(java.lang.Class,int,org.apache.hadoop.conf.Configuration)"> |
| <h3>load</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-257">load</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>> implClass, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf)</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> |
| <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="checkAndLoadInstance(java.lang.Class,int,org.apache.hadoop.conf.Configuration)"> |
| <h3>checkAndLoadInstance</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-269">checkAndLoadInstance</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> implClass, |
| int priority, |
| org.apache.hadoop.conf.Configuration conf)</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> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>implClass</code> - Implementation class</dd> |
| <dd><code>priority</code> - priority</dd> |
| <dd><code>conf</code> - configuration</dd> |
| <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> - Exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createEnvironment(C,int,int,org.apache.hadoop.conf.Configuration)"> |
| <h3 id="createEnvironment(org.apache.hadoop.hbase.Coprocessor,int,int,org.apache.hadoop.conf.Configuration)">createEnvironment</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-295">createEnvironment</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a> instance, |
| int priority, |
| int sequence, |
| org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Called when a new Coprocessor class is loaded</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkAndGetInstance(java.lang.Class)"> |
| <h3>checkAndGetInstance</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-304">checkAndGetInstance</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> implClass)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InstantiationException.html" title="class or interface in java.lang" class="external-link">InstantiationException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalAccessException.html" title="class or interface in java.lang" class="external-link">IllegalAccessException</a></span></div> |
| <div class="block">Called when a new Coprocessor class needs to be loaded. Checks if type of the given class is |
| what the corresponding host implementation expects. If it is of correct type, returns an |
| instance of the coprocessor to be loaded. If not, returns null. If an exception occurs when |
| trying to create instance of a coprocessor, it's passed up and eventually results into server |
| aborting.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InstantiationException.html" title="class or interface in java.lang" class="external-link">InstantiationException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalAccessException.html" title="class or interface in java.lang" class="external-link">IllegalAccessException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdown(E)"> |
| <h3 id="shutdown(org.apache.hadoop.hbase.CoprocessorEnvironment)">shutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-307">shutdown</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> e)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findCoprocessor(java.lang.String)"> |
| <h3>findCoprocessor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-318">findCoprocessor</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className)</span></div> |
| <div class="block">Find coprocessors by full class name or simple name.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findCoprocessor(java.lang.Class)"> |
| <h3>findCoprocessor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>></span> <span class="return-type">T</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-330">findCoprocessor</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> cls)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findCoprocessors(java.lang.Class)"> |
| <h3>findCoprocessors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><T></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-344">findCoprocessors</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> cls)</span></div> |
| <div class="block">Find list of coprocessors that extend/implement the given class/interface</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cls</code> - the class/interface to look for</dd> |
| <dt>Returns:</dt> |
| <dd>the list of coprocessors, or null if not found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findCoprocessorEnvironment(java.lang.String)"> |
| <h3>findCoprocessorEnvironment</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-364">findCoprocessorEnvironment</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> className)</span></div> |
| <div class="block">Find a coprocessor environment by class name</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>className</code> - the class name</dd> |
| <dt>Returns:</dt> |
| <dd>the coprocessor, or null if not found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExternalClassLoaders()"> |
| <h3>getExternalClassLoaders</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-381">getExternalClassLoaders</a></span>()</div> |
| <div class="block">Retrieves the set of classloaders used to instantiate Coprocessor classes defined in external |
| jar files.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A set of ClassLoader instances</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abortServer(E,java.lang.Throwable)"> |
| <h3 id="abortServer(org.apache.hadoop.hbase.CoprocessorEnvironment,java.lang.Throwable)">abortServer</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-414">abortServer</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> environment, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> e)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abortServer(java.lang.String,java.lang.Throwable)"> |
| <h3>abortServer</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-418">abortServer</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> coprocessorName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> e)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleCoprocessorThrowable(E,java.lang.Throwable)"> |
| <h3 id="handleCoprocessorThrowable(org.apache.hadoop.hbase.CoprocessorEnvironment,java.lang.Throwable)">handleCoprocessorThrowable</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-444">handleCoprocessorThrowable</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a> env, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> e)</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">This is used by coprocessor hooks which are declared to throw IOException (or its subtypes). |
| For such hooks, we should handle throwable objects depending on the Throwable's type. Those |
| which are instances of IOException should be passed on to the client. This is in conformance |
| with the HBase idiom regarding IOException: that it represents a circumstance that should be |
| passed along to the client for its own handling. For example, a coprocessor that implements |
| access controls would throw a subclass of IOException, such as AccessDeniedException, in its |
| preGet() method to prevent an unauthorized client's performing a Get on a particular table.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>env</code> - Coprocessor Environment</dd> |
| <dd><code>e</code> - Throwable object thrown by coprocessor.</dd> |
| <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> - Exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execOperationWithResult(org.apache.hadoop.hbase.coprocessor.CoprocessorHost.ObserverOperationWithResult)"> |
| <h3>execOperationWithResult</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="type-parameters"><O,<wbr> |
| R></span> <span class="return-type">R</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-607">execOperationWithResult</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>,<wbr><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>>.<a href="CoprocessorHost.ObserverOperationWithResult.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverOperationWithResult</a><O,<wbr>R> observerOperation)</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">Do not call with an observerOperation that is null! Have the caller check.</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="execOperation(org.apache.hadoop.hbase.coprocessor.CoprocessorHost.ObserverOperation)"> |
| <h3>execOperation</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="type-parameters"><O></span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-618">execOperation</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>,<wbr><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>>.<a href="CoprocessorHost.ObserverOperation.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverOperation</a><O> observerOperation)</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> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if we are to bypass (Can only be <code>true</code> if |
| ObserverOperation#isBypassable().</dd> |
| <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="execShutdown(org.apache.hadoop.hbase.coprocessor.CoprocessorHost.ObserverOperation)"> |
| <h3>execShutdown</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="type-parameters"><O></span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html#line-660">execShutdown</a></span><wbr><span class="parameters">(<a href="CoprocessorHost.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost</a><<a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">C</a>,<wbr><a href="CoprocessorHost.html" title="type parameter in CoprocessorHost">E</a>>.<a href="CoprocessorHost.ObserverOperation.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverOperation</a><O> observerOperation)</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">Coprocessor classes can be configured in any order, based on that priority is set and chained |
| in a sorted order. Should be used preStop*() hooks i.e. when master/regionserver is going down. |
| This function first calls coprocessor methods (using ObserverOperation.call()) and then |
| shutdowns the environment in postEnvCall(). <br> |
| Need to execute all coprocessor methods first then postEnvCall(), otherwise some coprocessors |
| may remain shutdown if any exception occurs during next coprocessor execution which prevent |
| master/regionserver stop or cluster shutdown. (Refer: |
| <a href="https://issues.apache.org/jira/browse/HBASE-16663">HBASE-16663</a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if bypaas coprocessor execution, false if not.</dd> |
| <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> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
