| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ObserverContext (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, interface: ObserverContext"> |
| <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/ObserverContext.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface ObserverContext" class="title">Interface ObserverContext<E extends <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>E</code> - The <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> subclass applicable to the revelant Observer |
| interface.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="CoprocessorHost.ObserverOperation.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverOperation</a></code>, <code><a href="CoprocessorHost.ObserverOperationWithoutResult.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverOperationWithoutResult</a></code>, <code><a href="CoprocessorHost.ObserverOperationWithResult.html" title="class in org.apache.hadoop.hbase.coprocessor">CoprocessorHost.ObserverOperationWithResult</a></code>, <code><a href="../master/MasterCoprocessorHost.MasterObserverOperation.html" title="class in org.apache.hadoop.hbase.master">MasterCoprocessorHost.MasterObserverOperation</a></code>, <code><a href="ObserverContextImpl.html" title="class in org.apache.hadoop.hbase.coprocessor">ObserverContextImpl</a></code>, <code><a href="../regionserver/RegionCoprocessorHost.BulkLoadObserverOperation.html" title="class in org.apache.hadoop.hbase.regionserver">RegionCoprocessorHost.BulkLoadObserverOperation</a></code>, <code><a href="../regionserver/RegionCoprocessorHost.RegionObserverOperationWithoutResult.html" title="class in org.apache.hadoop.hbase.regionserver">RegionCoprocessorHost.RegionObserverOperationWithoutResult</a></code>, <code><a href="../regionserver/RegionServerCoprocessorHost.RegionServerObserverOperation.html" title="class in org.apache.hadoop.hbase.regionserver">RegionServerCoprocessorHost.RegionServerObserverOperation</a></code>, <code><a href="../regionserver/wal/WALCoprocessorHost.WALObserverOperation.html" title="class in org.apache.hadoop.hbase.regionserver.wal">WALCoprocessorHost.WALObserverOperation</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/ObserverContext.html#line-37">ObserverContext</a><E extends <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>></span></div> |
| <div class="block">Carries the execution state for a given invocation of an Observer coprocessor |
| (<a href="RegionObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor"><code>RegionObserver</code></a>, <a href="MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor"><code>MasterObserver</code></a>, or <a href="WALObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor"><code>WALObserver</code></a>) method. The same |
| ObserverContext instance is passed sequentially to all loaded coprocessors for a given Observer |
| method trigger, with the <code>CoprocessorEnvironment</code> reference set appropriately for each |
| Coprocessor type: e.g. the RegionCoprocessorEnvironment is passed to RegionCoprocessors, and so |
| on.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-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></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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#bypass()" class="member-name-link">bypass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Call to indicate that the current coprocessor's return value (or parameter -- depends on the |
| call-type) should be used in place of the value that would be obtained via normal processing; |
| i.e.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCaller()" class="member-name-link">getCaller</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the active user for the coprocessor call.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ObserverContext.html" title="type parameter in ObserverContext">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="#getEnvironment()" class="member-name-link">getEnvironment</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getEnvironment()"> |
| <h3>getEnvironment</h3> |
| <div class="member-signature"><span class="return-type"><a href="ObserverContext.html" title="type parameter in ObserverContext">E</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html#line-40">getEnvironment</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bypass()"> |
| <h3>bypass</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html#line-70">bypass</a></span>()</div> |
| <div class="block">Call to indicate that the current coprocessor's return value (or parameter -- depends on the |
| call-type) should be used in place of the value that would be obtained via normal processing; |
| i.e. bypass the core call and return the Coprocessor's result instead. DOES NOT work for all |
| Coprocessor invocations, only on a small subset of methods, mostly preXXX calls in |
| RegionObserver. Check javadoc on the pertinent Coprocessor Observer to see if |
| <code>bypass</code> is supported. |
| <p> |
| This behavior of honoring only a subset of methods is new since hbase-2.0.0. |
| <p> |
| Where bypass is supported what is being bypassed is all of the core code implementing the |
| remainder of the operation. In order to understand what calling bypass() will skip, a |
| coprocessor implementer should read and understand all of the remaining code and its nuances. |
| Although this is good practice for coprocessor developers in general, it demands a lot. What is |
| skipped is extremely version dependent. The core code will vary, perhaps significantly, even |
| between point releases. We do not provide the promise of consistent behavior even between point |
| releases for the bypass semantic. To achieve that we could not change any code between hook |
| points. Therefore the coprocessor implementer becomes an HBase core developer in practice as |
| soon as they rely on bypass(). Every release of HBase may break the assumption that the |
| replacement for the bypassed code takes care of all necessary skipped concerns. Because those |
| concerns can change at any point, such an assumption is never safe. |
| </p> |
| <p> |
| As of hbase2, when bypass has been set, we will NOT call any Coprocessors follow the bypassing |
| Coprocessor; we cut short the processing and return the bypassing Coprocessors response (this |
| used be a separate 'complete' option that has been folded into the 'bypass' in hbase2. |
| </p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCaller()"> |
| <h3>getCaller</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html#line-78">getCaller</a></span>()</div> |
| <div class="block">Returns the active user for the coprocessor call. If an explicit <code>User</code> instance was |
| provided to the constructor, that will be returned, otherwise if we are in the context of an |
| RPC call, the remote user is used. May not be present if the execution is outside of an RPC |
| context.</div> |
| </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> |
