| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TableHFileArchiveTracker (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.backup.example, class: TableHFileArchiveTracker"> |
| <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/TableHFileArchiveTracker.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.backup.example</a></div> |
| <h1 title="Class TableHFileArchiveTracker" class="title">Class TableHFileArchiveTracker</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"><a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">org.apache.hadoop.hbase.zookeeper.ZKListener</a> |
| <div class="inheritance">org.apache.hadoop.hbase.backup.example.TableHFileArchiveTracker</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public final class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-39">TableHFileArchiveTracker</a></span> |
| <span class="extends-implements">extends <a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKListener</a></span></div> |
| <div class="block">Track HFile archiving state changes in ZooKeeper. Keeps track of the tables whose HFiles should |
| be kept in the archive. |
| <p> |
| <a href="#start()"><code>start()</code></a> needs to be called to start monitoring for tables to |
| archive.</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 <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="#archiveHFileZNode" class="member-name-link">archiveHFileZNode</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="#HFILE_ARCHIVE_ZNODE_PARENT" class="member-name-link">HFILE_ARCHIVE_ZNODE_PARENT</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>private <a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#monitor" class="member-name-link">monitor</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#stopped" class="member-name-link">stopped</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.zookeeper.ZKListener">Fields inherited from class org.apache.hadoop.hbase.zookeeper.<a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKListener</a></h3> |
| <code><a href="../../zookeeper/ZKListener.html#watcher">watcher</a></code></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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.zookeeper.ZKWatcher,org.apache.hadoop.hbase.backup.example.HFileArchiveTableMonitor)" class="member-name-link">TableHFileArchiveTracker</a><wbr>(<a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> watcher, |
| <a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a> monitor)</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-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>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="#addAndReWatchTable(java.lang.String)" class="member-name-link">addAndReWatchTable</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> tableZnode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add this table to the tracker and then read a watch on that node.</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="#checkEnabledAndUpdate()" class="member-name-link">checkEnabledAndUpdate</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the watch on the top-level archive znode, and then updates the monitor with the current |
| tables that should be archived (and ensures that those nodes are watched as well).</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="#clearTables()" class="member-name-link">clearTables</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove the currently archived tables.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TableHFileArchiveTracker.html" title="class in org.apache.hadoop.hbase.backup.example">TableHFileArchiveTracker</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.hadoop.conf.Configuration)" class="member-name-link">create</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create an archive tracker for the passed in server</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <a href="TableHFileArchiveTracker.html" title="class in org.apache.hadoop.hbase.backup.example">TableHFileArchiveTracker</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.hadoop.hbase.zookeeper.ZKWatcher,org.apache.hadoop.hbase.backup.example.HFileArchiveTableMonitor)" class="member-name-link">create</a><wbr>(<a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, |
| <a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a> monitor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create an archive tracker with the special passed in table monitor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMonitor()" class="member-name-link">getMonitor</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the tracker for which tables should be archived.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getZooKeeperWatcher()" class="member-name-link">getZooKeeperWatcher</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>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keepHFiles(java.lang.String)" class="member-name-link">keepHFiles</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> tableName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determine if the given table should or should not allow its hfiles to be deleted</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="#nodeChildrenChanged(java.lang.String)" class="member-name-link">nodeChildrenChanged</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">Called when an existing node has a child node added or removed.</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="#nodeCreated(java.lang.String)" class="member-name-link">nodeCreated</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">Called when a new node has been created.</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="#nodeDeleted(java.lang.String)" class="member-name-link">nodeDeleted</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">Called when a node has been deleted</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="#safeStopTrackingTable(java.lang.String)" class="member-name-link">safeStopTrackingTable</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> tableZnode)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stop tracking a table.</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()" class="member-name-link">start</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Start monitoring for archive updates</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="#stop()" class="member-name-link">stop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stop this tracker and the passed zookeeper</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="#updateWatchedTables()" class="member-name-link">updateWatchedTables</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Read the list of children under the archive znode as table names and then sets those tables to |
| the list of tables that we should archive</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.zookeeper.ZKListener">Methods inherited from class org.apache.hadoop.hbase.zookeeper.<a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKListener</a></h3> |
| <code><a href="../../zookeeper/ZKListener.html#getWatcher()">getWatcher</a>, <a href="../../zookeeper/ZKListener.html#nodeDataChanged(java.lang.String)">nodeDataChanged</a></code></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/backup/example/TableHFileArchiveTracker.html#line-41">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="HFILE_ARCHIVE_ZNODE_PARENT"> |
| <h3>HFILE_ARCHIVE_ZNODE_PARENT</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/backup/example/TableHFileArchiveTracker.html#line-42">HFILE_ARCHIVE_ZNODE_PARENT</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.backup.example.TableHFileArchiveTracker.HFILE_ARCHIVE_ZNODE_PARENT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="monitor"> |
| <h3>monitor</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-43">monitor</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="archiveHFileZNode"> |
| <h3>archiveHFileZNode</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/backup/example/TableHFileArchiveTracker.html#line-44">archiveHFileZNode</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stopped"> |
| <h3>stopped</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-45">stopped</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,org.apache.hadoop.hbase.backup.example.HFileArchiveTableMonitor)"> |
| <h3>TableHFileArchiveTracker</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-47">TableHFileArchiveTracker</a></span><wbr><span class="parameters">(<a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> watcher, |
| <a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a> monitor)</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="start()"> |
| <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/backup/example/TableHFileArchiveTracker.html#line-59">start</a></span>() |
| throws <span class="exceptions">org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Start monitoring for archive updates</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - on failure to find/create nodes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nodeCreated(java.lang.String)"> |
| <h3>nodeCreated</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/backup/example/TableHFileArchiveTracker.html#line-66">nodeCreated</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"><span class="descfrm-type-label">Description copied from class: <code><a href="../../zookeeper/ZKListener.html#nodeCreated(java.lang.String)">ZKListener</a></code></span></div> |
| <div class="block">Called when a new node has been created.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../zookeeper/ZKListener.html#nodeCreated(java.lang.String)">nodeCreated</a></code> in class <code><a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKListener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - full path of the new node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nodeChildrenChanged(java.lang.String)"> |
| <h3>nodeChildrenChanged</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/backup/example/TableHFileArchiveTracker.html#line-91">nodeChildrenChanged</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"><span class="descfrm-type-label">Description copied from class: <code><a href="../../zookeeper/ZKListener.html#nodeChildrenChanged(java.lang.String)">ZKListener</a></code></span></div> |
| <div class="block">Called when an existing node has a child node added or removed.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../zookeeper/ZKListener.html#nodeChildrenChanged(java.lang.String)">nodeChildrenChanged</a></code> in class <code><a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKListener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - full path of the node whose children have changed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAndReWatchTable(java.lang.String)"> |
| <h3>addAndReWatchTable</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/backup/example/TableHFileArchiveTracker.html#line-114">addAndReWatchTable</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> tableZnode)</span> |
| throws <span class="exceptions">org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Add this table to the tracker and then read a watch on that node. |
| <p> |
| Handles situation where table is deleted in the time between the update and resetting the watch |
| by deleting the table via <a href="#safeStopTrackingTable(java.lang.String)"><code>safeStopTrackingTable(String)</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tableZnode</code> - full zookeeper path to the table to be added</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if an unexpected zk exception occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="safeStopTrackingTable(java.lang.String)"> |
| <h3>safeStopTrackingTable</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/backup/example/TableHFileArchiveTracker.html#line-129">safeStopTrackingTable</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> tableZnode)</span> |
| throws <span class="exceptions">org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Stop tracking a table. Ensures that the table doesn't exist, but if it does, it attempts to add |
| the table back via <a href="#addAndReWatchTable(java.lang.String)"><code>addAndReWatchTable(String)</code></a> - its a 'safe' removal.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tableZnode</code> - full zookeeper path to the table to be added</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if an unexpected zk exception occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nodeDeleted(java.lang.String)"> |
| <h3>nodeDeleted</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/backup/example/TableHFileArchiveTracker.html#line-137">nodeDeleted</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"><span class="descfrm-type-label">Description copied from class: <code><a href="../../zookeeper/ZKListener.html#nodeDeleted(java.lang.String)">ZKListener</a></code></span></div> |
| <div class="block">Called when a node has been deleted</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../zookeeper/ZKListener.html#nodeDeleted(java.lang.String)">nodeDeleted</a></code> in class <code><a href="../../zookeeper/ZKListener.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKListener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - full path of the deleted node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkEnabledAndUpdate()"> |
| <h3>checkEnabledAndUpdate</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/backup/example/TableHFileArchiveTracker.html#line-169">checkEnabledAndUpdate</a></span>()</div> |
| <div class="block">Sets the watch on the top-level archive znode, and then updates the monitor with the current |
| tables that should be archived (and ensures that those nodes are watched as well).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateWatchedTables()"> |
| <h3>updateWatchedTables</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/backup/example/TableHFileArchiveTracker.html#line-191">updateWatchedTables</a></span>() |
| throws <span class="exceptions">org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Read the list of children under the archive znode as table names and then sets those tables to |
| the list of tables that we should archive</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if there is an unexpected zk exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearTables()"> |
| <h3>clearTables</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/backup/example/TableHFileArchiveTracker.html#line-212">clearTables</a></span>()</div> |
| <div class="block">Remove the currently archived tables. |
| <p> |
| Does some intelligent checking to make sure we don't prematurely create an archive tracker.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keepHFiles(java.lang.String)"> |
| <h3>keepHFiles</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-221">keepHFiles</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> tableName)</span></div> |
| <div class="block">Determine if the given table should or should not allow its hfiles to be deleted</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tableName</code> - name of the table to check</dd> |
| <dt>Returns:</dt> |
| <dd><tt>true</tt> if its store files should be retained, <tt>false</tt> otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonitor()"> |
| <h3>getMonitor</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-226">getMonitor</a></span>()</div> |
| <div class="block">Returns the tracker for which tables should be archived.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(org.apache.hadoop.conf.Configuration)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TableHFileArchiveTracker.html" title="class in org.apache.hadoop.hbase.backup.example">TableHFileArchiveTracker</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-238">create</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="../../ZooKeeperConnectionException.html" title="class in org.apache.hadoop.hbase">ZooKeeperConnectionException</a>, |
| <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">Create an archive tracker for the passed in server</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - to read for zookeeper connection information</dd> |
| <dt>Returns:</dt> |
| <dd>ZooKeeper tracker to monitor for this server if this server should archive hfiles for a |
| given table</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 a unexpected exception occurs</dd> |
| <dd><code><a href="../../ZooKeeperConnectionException.html" title="class in org.apache.hadoop.hbase">ZooKeeperConnectionException</a></code> - if we can't reach zookeeper</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(org.apache.hadoop.hbase.zookeeper.ZKWatcher,org.apache.hadoop.hbase.backup.example.HFileArchiveTableMonitor)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="TableHFileArchiveTracker.html" title="class in org.apache.hadoop.hbase.backup.example">TableHFileArchiveTracker</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-252">create</a></span><wbr><span class="parameters">(<a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, |
| <a href="HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveTableMonitor</a> monitor)</span></div> |
| <div class="block">Create an archive tracker with the special passed in table monitor. Should only be used in |
| special cases (e.g. testing)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>zkw</code> - Watcher for the ZooKeeper cluster that we should track</dd> |
| <dd><code>monitor</code> - Monitor for which tables need hfile archiving</dd> |
| <dt>Returns:</dt> |
| <dd>ZooKeeper tracker to monitor for this server if this server should archive hfiles for a |
| given table</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getZooKeeperWatcher()"> |
| <h3>getZooKeeperWatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html#line-256">getZooKeeperWatcher</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop()"> |
| <h3>stop</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/backup/example/TableHFileArchiveTracker.html#line-263">stop</a></span>()</div> |
| <div class="block">Stop this tracker and the passed zookeeper</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> |
