| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ZKProcedureMemberRpcs (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.procedure, class: ZKProcedureMemberRpcs"> |
| <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/ZKProcedureMemberRpcs.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><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.procedure</a></div> |
| <h1 title="Class ZKProcedureMemberRpcs" class="title">Class ZKProcedureMemberRpcs</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.procedure.ZKProcedureMemberRpcs</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-53">ZKProcedureMemberRpcs</a></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> |
| implements <a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></span></div> |
| <div class="block">ZooKeeper based controller for a procedure member. |
| <p> |
| There can only be one <a href="ZKProcedureMemberRpcs.html" title="class in org.apache.hadoop.hbase.procedure"><code>ZKProcedureMemberRpcs</code></a> per procedure type per member, since each |
| procedure type is bound to a single set of znodes. You can have multiple |
| <a href="ZKProcedureMemberRpcs.html" title="class in org.apache.hadoop.hbase.procedure"><code>ZKProcedureMemberRpcs</code></a> on the same server, each serving a different member name, but each |
| individual rpcs is still bound to a single member name (and since they are used to determine |
| global progress, its important to not get this wrong). |
| <p> |
| To make this slightly more confusing, you can run multiple, concurrent procedures at the same |
| time (as long as they have different types), from the same controller, but the same node name |
| must be used for each procedure (though there is no conflict between the two procedure as long as |
| they have distinct names). |
| <p> |
| There is no real error recovery with this mechanism currently -- if any the coordinator fails, |
| its re-initialization will delete the znodes and require all in progress subprocedures to start |
| anew.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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>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>protected <a href="ProcedureMember.html" title="class in org.apache.hadoop.hbase.procedure">ProcedureMember</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#member" class="member-name-link">member</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <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="#memberName" class="member-name-link">memberName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="ZKProcedureUtil.html" title="class in org.apache.hadoop.hbase.procedure">ZKProcedureUtil</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#zkController" class="member-name-link">zkController</a></code></div> |
| <div class="col-last odd-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.zookeeper.ZKWatcher,java.lang.String)" class="member-name-link">ZKProcedureMemberRpcs</a><wbr>(<a href="../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> watcher, |
| <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> procType)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Must call <a href="#start(java.lang.String,org.apache.hadoop.hbase.procedure.ProcedureMember)"><code>start(String, ProcedureMember)</code></a> before this can be used.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-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="#abort(java.lang.String)" class="member-name-link">abort</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> abortZNode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Pass along the found abort notification to the listener</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</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><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="#getMemberName()" class="member-name-link">getMemberName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Each subprocedure is being executed on a member.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ZKProcedureUtil.html" title="class in org.apache.hadoop.hbase.procedure">ZKProcedureUtil</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getZkController()" class="member-name-link">getZkController</a>()</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>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#receivedReachedGlobalBarrier(java.lang.String)" class="member-name-link">receivedReachedGlobalBarrier</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> path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Pass along the procedure global barrier notification to any listeners</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendMemberAborted(org.apache.hadoop.hbase.procedure.Subprocedure,org.apache.hadoop.hbase.errorhandling.ForeignException)" class="member-name-link">sendMemberAborted</a><wbr>(<a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure">Subprocedure</a> sub, |
| <a href="../errorhandling/ForeignException.html" title="class in org.apache.hadoop.hbase.errorhandling">ForeignException</a> ee)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This should be called by the member and should write a serialized root cause exception as to |
| the abort znode.</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="#sendMemberAcquired(org.apache.hadoop.hbase.procedure.Subprocedure)" class="member-name-link">sendMemberAcquired</a><wbr>(<a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure">Subprocedure</a> sub)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This attempts to create an acquired state znode for the procedure (snapshot name).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendMemberCompleted(org.apache.hadoop.hbase.procedure.Subprocedure,byte%5B%5D)" class="member-name-link">sendMemberCompleted</a><wbr>(<a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure">Subprocedure</a> sub, |
| byte[] data)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This acts as the ack for a completed procedure</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="#start(java.lang.String,org.apache.hadoop.hbase.procedure.ProcedureMember)" class="member-name-link">start</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> memberName, |
| <a href="ProcedureMember.html" title="class in org.apache.hadoop.hbase.procedure">ProcedureMember</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Initialize and start any threads or connections the member needs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startNewSubprocedure(java.lang.String)" class="member-name-link">startNewSubprocedure</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> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Kick off a new sub-procedure on the listener with the data stored in the passed znode.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#waitForNewProcedures()" class="member-name-link">waitForNewProcedures</a>()</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>private void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#watchForAbortedProcedures()" class="member-name-link">watchForAbortedProcedures</a>()</code></div> |
| <div class="col-last odd-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="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/procedure/ZKProcedureMemberRpcs.html#line-55">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="zkController"> |
| <h3>zkController</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="ZKProcedureUtil.html" title="class in org.apache.hadoop.hbase.procedure">ZKProcedureUtil</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-57">zkController</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="member"> |
| <h3>member</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="ProcedureMember.html" title="class in org.apache.hadoop.hbase.procedure">ProcedureMember</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-59">member</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="memberName"> |
| <h3>memberName</h3> |
| <div class="member-signature"><span class="modifiers">private</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/procedure/ZKProcedureMemberRpcs.html#line-60">memberName</a></span></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.zookeeper.ZKWatcher,java.lang.String)"> |
| <h3>ZKProcedureMemberRpcs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-68">ZKProcedureMemberRpcs</a></span><wbr><span class="parameters">(<a href="../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> watcher, |
| <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> procType)</span> |
| throws <span class="exceptions">org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Must call <a href="#start(java.lang.String,org.apache.hadoop.hbase.procedure.ProcedureMember)"><code>start(String, ProcedureMember)</code></a> before this can be used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>watcher</code> - <a href="../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> to be owned by <tt>this</tt>. Closed via <a href="#close()"><code>close()</code></a>.</dd> |
| <dd><code>procType</code> - name of the znode describing the procedure type</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if we can't reach zookeeper</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getZkController()"> |
| <h3>getZkController</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ZKProcedureUtil.html" title="class in org.apache.hadoop.hbase.procedure">ZKProcedureUtil</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-114">getZkController</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemberName()"> |
| <h3>getMemberName</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/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/procedure/ZKProcedureMemberRpcs.html#line-118">getMemberName</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProcedureMemberRpcs.html#getMemberName()">ProcedureMemberRpcs</a></code></span></div> |
| <div class="block">Each subprocedure is being executed on a member. This is the identifier for the member.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProcedureMemberRpcs.html#getMemberName()">getMemberName</a></code> in interface <code><a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the member name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="receivedReachedGlobalBarrier(java.lang.String)"> |
| <h3>receivedReachedGlobalBarrier</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-127">receivedReachedGlobalBarrier</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> path)</span></div> |
| <div class="block">Pass along the procedure global barrier notification to any listeners</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - full znode path that cause the notification</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="watchForAbortedProcedures()"> |
| <h3>watchForAbortedProcedures</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-133">watchForAbortedProcedures</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="waitForNewProcedures()"> |
| <h3>waitForNewProcedures</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-152">waitForNewProcedures</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startNewSubprocedure(java.lang.String)"> |
| <h3>startNewSubprocedure</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html#line-185">startNewSubprocedure</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> path)</span></div> |
| <div class="block">Kick off a new sub-procedure on the listener with the data stored in the passed znode. |
| <p> |
| Will attempt to create the same procedure multiple times if an procedure znode with the same |
| name is created. It is left up the coordinator to ensure this doesn't occur.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - full path to the znode for the procedure to start</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sendMemberAcquired(org.apache.hadoop.hbase.procedure.Subprocedure)"> |
| <h3>sendMemberAcquired</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/procedure/ZKProcedureMemberRpcs.html#line-238">sendMemberAcquired</a></span><wbr><span class="parameters">(<a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure">Subprocedure</a> sub)</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 attempts to create an acquired state znode for the procedure (snapshot name). It then |
| looks for the reached znode to trigger in-barrier execution. If not present we have a watcher, |
| if present then trigger the in-barrier action.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProcedureMemberRpcs.html#sendMemberAcquired(org.apache.hadoop.hbase.procedure.Subprocedure)">sendMemberAcquired</a></code> in interface <code><a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sub</code> - the specified <a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure"><code>Subprocedure</code></a></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> - if we can't reach the coordinator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sendMemberCompleted(org.apache.hadoop.hbase.procedure.Subprocedure,byte[])"> |
| <h3>sendMemberCompleted</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/procedure/ZKProcedureMemberRpcs.html#line-264">sendMemberCompleted</a></span><wbr><span class="parameters">(<a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure">Subprocedure</a> sub, |
| byte[] data)</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 acts as the ack for a completed procedure</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProcedureMemberRpcs.html#sendMemberCompleted(org.apache.hadoop.hbase.procedure.Subprocedure,byte%5B%5D)">sendMemberCompleted</a></code> in interface <code><a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sub</code> - the specified <a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure"><code>Subprocedure</code></a></dd> |
| <dd><code>data</code> - the data the member returns to the coordinator along with the notification</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> - if we can't reach the coordinator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sendMemberAborted(org.apache.hadoop.hbase.procedure.Subprocedure,org.apache.hadoop.hbase.errorhandling.ForeignException)"> |
| <h3>sendMemberAborted</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/procedure/ZKProcedureMemberRpcs.html#line-288">sendMemberAborted</a></span><wbr><span class="parameters">(<a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure">Subprocedure</a> sub, |
| <a href="../errorhandling/ForeignException.html" title="class in org.apache.hadoop.hbase.errorhandling">ForeignException</a> ee)</span></div> |
| <div class="block">This should be called by the member and should write a serialized root cause exception as to |
| the abort znode.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProcedureMemberRpcs.html#sendMemberAborted(org.apache.hadoop.hbase.procedure.Subprocedure,org.apache.hadoop.hbase.errorhandling.ForeignException)">sendMemberAborted</a></code> in interface <code><a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sub</code> - the <a href="Subprocedure.html" title="class in org.apache.hadoop.hbase.procedure"><code>Subprocedure</code></a> we are aborting</dd> |
| <dd><code>ee</code> - the reason why the member's subprocedure aborted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abort(java.lang.String)"> |
| <h3>abort</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/procedure/ZKProcedureMemberRpcs.html#line-315">abort</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> abortZNode)</span></div> |
| <div class="block">Pass along the found abort notification to the listener</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>abortZNode</code> - full znode path to the failed procedure information</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start(java.lang.String,org.apache.hadoop.hbase.procedure.ProcedureMember)"> |
| <h3>start</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/procedure/ZKProcedureMemberRpcs.html#line-355">start</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> memberName, |
| <a href="ProcedureMember.html" title="class in org.apache.hadoop.hbase.procedure">ProcedureMember</a> listener)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProcedureMemberRpcs.html#start(java.lang.String,org.apache.hadoop.hbase.procedure.ProcedureMember)">ProcedureMemberRpcs</a></code></span></div> |
| <div class="block">Initialize and start any threads or connections the member needs.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProcedureMemberRpcs.html#start(java.lang.String,org.apache.hadoop.hbase.procedure.ProcedureMember)">start</a></code> in interface <code><a href="ProcedureMemberRpcs.html" title="interface in org.apache.hadoop.hbase.procedure">ProcedureMemberRpcs</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</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/procedure/ZKProcedureMemberRpcs.html#line-364">close</a></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>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></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> |