http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html new file mode 100644 index 0000000..029f97c --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html @@ -0,0 +1,360 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_80) on Mon Nov 07 22:02:59 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HFileArchiver (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HFileArchiver (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HFileArchiver.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/backup/HFileArchiver.html" target="_top">Frames</a></li> +<li><a href="HFileArchiver.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase.backup</div> +<h2 title="Class HFileArchiver" class="title">Class HFileArchiver</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.backup.HFileArchiver</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">HFileArchiver</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility class to handle the removal of HFiles (or the respective <a href="../../../../../org/apache/hadoop/hbase/regionserver/StoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>StoreFiles</code></a>) + for a HRegion from the <code>FileSystem</code>. The hfiles will be archived or deleted, depending on + the state of the system.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveFamily(org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.hbase.HRegionInfo,%20org.apache.hadoop.fs.Path,%20byte[])">archiveFamily</a></strong>(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> parent, + org.apache.hadoop.fs.Path tableDir, + byte[] family)</code> +<div class="block">Remove from the specified region the store files of the specified column family, + either by archiving them or outright deletion</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveRegion(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.hbase.HRegionInfo)">archiveRegion</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> info)</code> +<div class="block">Cleans up all the files for a HRegion by archiving the HFiles to the + archive directory</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveRegion(org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.fs.Path,%20org.apache.hadoop.fs.Path,%20org.apache.hadoop.fs.Path)">archiveRegion</a></strong>(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + org.apache.hadoop.fs.Path tableDir, + org.apache.hadoop.fs.Path regionDir)</code> +<div class="block">Remove an entire region from the table directory via archiving the region's hfiles.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveStoreFile(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.hbase.HRegionInfo,%20org.apache.hadoop.fs.Path,%20byte[],%20org.apache.hadoop.fs.Path)">archiveStoreFile</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> regionInfo, + org.apache.hadoop.fs.Path tableDir, + byte[] family, + org.apache.hadoop.fs.Path storeFile)</code> +<div class="block">Archive the store file</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveStoreFiles(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.hbase.HRegionInfo,%20org.apache.hadoop.fs.Path,%20byte[],%20java.util.Collection)">archiveStoreFiles</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> regionInfo, + org.apache.hadoop.fs.Path tableDir, + byte[] family, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/StoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFile</a>> compactedFiles)</code> +<div class="block">Remove the store files, either by archiving them or outright deletion</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="archiveRegion(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.hbase.HRegionInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>archiveRegion</h4> +<pre>public static void archiveRegion(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> info) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Cleans up all the files for a HRegion by archiving the HFiles to the + archive directory</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the configuration to use</dd><dd><code>fs</code> - the file system object</dd><dd><code>info</code> - HRegionInfo for region to be deleted</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="archiveRegion(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>archiveRegion</h4> +<pre>public static boolean archiveRegion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + org.apache.hadoop.fs.Path tableDir, + org.apache.hadoop.fs.Path regionDir) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Remove an entire region from the table directory via archiving the region's hfiles.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fs</code> - <code>FileSystem</code> from which to remove the region</dd><dd><code>rootdir</code> - <code>Path</code> to the root directory where hbase files are stored (for building + the archive path)</dd><dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive path)</dd><dd><code>regionDir</code> - <code>Path</code> to where a region is being stored (for building the archive path)</dd> +<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if the region was sucessfully deleted. <tt>false</tt> if the filesystem + operations could not complete.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the request cannot be completed</dd></dl> +</li> +</ul> +<a name="archiveFamily(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.hbase.HRegionInfo, org.apache.hadoop.fs.Path, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>archiveFamily</h4> +<pre>public static void archiveFamily(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> parent, + org.apache.hadoop.fs.Path tableDir, + byte[] family) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Remove from the specified region the store files of the specified column family, + either by archiving them or outright deletion</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fs</code> - the filesystem where the store files live</dd><dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd><dd><code>parent</code> - Parent region hosting the store files</dd><dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive path)</dd><dd><code>family</code> - the family hosting the store files</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the files could not be correctly disposed.</dd></dl> +</li> +</ul> +<a name="archiveStoreFiles(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.hbase.HRegionInfo, org.apache.hadoop.fs.Path, byte[], java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>archiveStoreFiles</h4> +<pre>public static void archiveStoreFiles(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> regionInfo, + org.apache.hadoop.fs.Path tableDir, + byte[] family, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/StoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFile</a>> compactedFiles) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Remove the store files, either by archiving them or outright deletion</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd><dd><code>fs</code> - the filesystem where the store files live</dd><dd><code>regionInfo</code> - <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase"><code>HRegionInfo</code></a> of the region hosting the store files</dd><dd><code>family</code> - the family hosting the store files</dd><dd><code>compactedFiles</code> - files to be disposed of. No further reading of these files should be + attempted; otherwise likely to cause an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the files could not be correctly disposed.</dd></dl> +</li> +</ul> +<a name="archiveStoreFile(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.hbase.HRegionInfo, org.apache.hadoop.fs.Path, byte[], org.apache.hadoop.fs.Path)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>archiveStoreFile</h4> +<pre>public static void archiveStoreFile(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + <a href="../../../../../org/apache/hadoop/hbase/HRegionInfo.html" title="class in org.apache.hadoop.hbase">HRegionInfo</a> regionInfo, + org.apache.hadoop.fs.Path tableDir, + byte[] family, + org.apache.hadoop.fs.Path storeFile) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Archive the store file</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fs</code> - the filesystem where the store files live</dd><dd><code>regionInfo</code> - region hosting the store files</dd><dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd><dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive path)</dd><dd><code>family</code> - the family hosting the store files</dd><dd><code>storeFile</code> - file to be archived</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the files could not be correctly disposed.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HFileArchiver.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/backup/HFileArchiver.html" target="_top">Frames</a></li> +<li><a href="HFileArchiver.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html new file mode 100644 index 0000000..a0b29f6 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html @@ -0,0 +1,117 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_80) on Mon Nov 07 22:03:41 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Class org.apache.hadoop.hbase.backup.HFileArchiver (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.hadoop.hbase.backup.HFileArchiver (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html" title="class in org.apache.hadoop.hbase.backup">Class</a></li> +<li class="navBarCell1Rev">Use</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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html" target="_top">Frames</a></li> +<li><a href="HFileArchiver.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.hadoop.hbase.backup.HFileArchiver" class="title">Uses of Class<br>org.apache.hadoop.hbase.backup.HFileArchiver</h2> +</div> +<div class="classUseContainer">No usage of org.apache.hadoop.hbase.backup.HFileArchiver</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html" title="class in org.apache.hadoop.hbase.backup">Class</a></li> +<li class="navBarCell1Rev">Use</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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html" target="_top">Frames</a></li> +<li><a href="HFileArchiver.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html new file mode 100644 index 0000000..558a01c --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html @@ -0,0 +1,331 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_80) on Mon Nov 07 22:02:59 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HFileArchiveTableMonitor (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HFileArchiveTableMonitor (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HFileArchiveTableMonitor.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html" title="class in org.apache.hadoop.hbase.backup.example"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html" target="_top">Frames</a></li> +<li><a href="HFileArchiveTableMonitor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase.backup.example</div> +<h2 title="Class HFileArchiveTableMonitor" class="title">Class HFileArchiveTableMonitor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.backup.example.HFileArchiveTableMonitor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">HFileArchiveTableMonitor</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Monitor the actual tables for which HFiles are archived for long-term retention (always kept + unless ZK state changes). + <p> + It is internally synchronized to ensure consistent view of the table state.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html#HFileArchiveTableMonitor()">HFileArchiveTableMonitor</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html#addTable(java.lang.String)">addTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> table)</code> +<div class="block">Add the named table to be those being archived.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html#clearArchive()">clearArchive</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html#removeTable(java.lang.String)">removeTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> table)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html#setArchiveTables(java.util.List)">setArchiveTables</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> tables)</code> +<div class="block">Set the tables to be archived.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html#shouldArchiveTable(java.lang.String)">shouldArchiveTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tableName)</code> +<div class="block">Determine if the given table should or should not allow its hfiles to be deleted in the archive</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HFileArchiveTableMonitor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HFileArchiveTableMonitor</h4> +<pre>public HFileArchiveTableMonitor()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setArchiveTables(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setArchiveTables</h4> +<pre>public void setArchiveTables(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> tables)</pre> +<div class="block">Set the tables to be archived. Internally adds each table and attempts to + register it. + <p> + <b>Note: All previous tables will be removed in favor of these tables.<b></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tables</code> - add each of the tables to be archived.</dd></dl> +</li> +</ul> +<a name="addTable(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTable</h4> +<pre>public void addTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> table)</pre> +<div class="block">Add the named table to be those being archived. Attempts to register the + table</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - name of the table to be registered</dd></dl> +</li> +</ul> +<a name="removeTable(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTable</h4> +<pre>public void removeTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> table)</pre> +</li> +</ul> +<a name="clearArchive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearArchive</h4> +<pre>public void clearArchive()</pre> +</li> +</ul> +<a name="shouldArchiveTable(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shouldArchiveTable</h4> +<pre>public boolean shouldArchiveTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tableName)</pre> +<div class="block">Determine if the given table should or should not allow its hfiles to be deleted in the archive</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tableName</code> - name of the table to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if its store files should be retained, <tt>false</tt> otherwise</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HFileArchiveTableMonitor.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html" title="class in org.apache.hadoop.hbase.backup.example"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html" target="_top">Frames</a></li> +<li><a href="HFileArchiveTableMonitor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html new file mode 100644 index 0000000..2123886 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html @@ -0,0 +1,364 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_80) on Mon Nov 07 22:02:59 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LongTermArchivingHFileCleaner (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="LongTermArchivingHFileCleaner (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LongTermArchivingHFileCleaner.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html" title="class in org.apache.hadoop.hbase.backup.example"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html" target="_top">Frames</a></li> +<li><a href="LongTermArchivingHFileCleaner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase.backup.example</div> +<h2 title="Class LongTermArchivingHFileCleaner" class="title">Class LongTermArchivingHFileCleaner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/hadoop/hbase/BaseConfigurable.html" title="class in org.apache.hadoop.hbase">org.apache.hadoop.hbase.BaseConfigurable</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">org.apache.hadoop.hbase.master.cleaner.BaseFileCleanerDelegate</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">org.apache.hadoop.hbase.master.cleaner.BaseHFileCleanerDelegate</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.backup.example.LongTermArchivingHFileCleaner</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.conf.Configurable, <a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/FileCleanerDelegate.html" title="interface in org.apache.hadoop.hbase.master.cleaner">FileCleanerDelegate</a>, <a href="../../../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.LimitedPrivate</a>(<a href="../../../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.LimitedPrivate.html#value()">value</a>="Configuration") +public class <span class="strong">LongTermArchivingHFileCleaner</span> +extends <a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">BaseHFileCleanerDelegate</a></pre> +<div class="block"><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner"><code>BaseHFileCleanerDelegate</code></a> that only cleans HFiles that don't belong to a table that is + currently being archived. + <p> + This only works properly if the + <a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/TimeToLiveHFileCleaner.html" title="class in org.apache.hadoop.hbase.master.cleaner"><code>TimeToLiveHFileCleaner</code></a> is also enabled + (it always should be), since it may take a little time for the ZK notification to + propagate, in which case we may accidentally delete some files.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html#LongTermArchivingHFileCleaner()">LongTermArchivingHFileCleaner</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html#isFileDeletable(org.apache.hadoop.fs.FileStatus)">isFileDeletable</a></strong>(org.apache.hadoop.fs.FileStatus fStat)</code> +<div class="block">Should the master delete the file or keep it?</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html#setConf(org.apache.hadoop.conf.Configuration)">setConf</a></strong>(org.apache.hadoop.conf.Configuration config)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html#stop(java.lang.String)">stop</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> reason)</code> +<div class="block">Stop this service.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.hbase.master.cleaner.BaseHFileCleanerDelegate"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hadoop.hbase.master.cleaner.<a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">BaseHFileCleanerDelegate</a></h3> +<code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html#isStopped()">isStopped</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.hbase.master.cleaner.BaseFileCleanerDelegate"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hadoop.hbase.master.cleaner.<a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">BaseFileCleanerDelegate</a></h3> +<code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html#getDeletableFiles(java.lang.Iterable)">getDeletableFiles</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.hbase.BaseConfigurable"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hadoop.hbase.<a href="../../../../../../org/apache/hadoop/hbase/BaseConfigurable.html" title="class in org.apache.hadoop.hbase">BaseConfigurable</a></h3> +<code><a href="../../../../../../org/apache/hadoop/hbase/BaseConfigurable.html#getConf()">getConf</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.conf.Configurable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.conf.Configurable</h3> +<code>getConf</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LongTermArchivingHFileCleaner()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LongTermArchivingHFileCleaner</h4> +<pre>public LongTermArchivingHFileCleaner()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isFileDeletable(org.apache.hadoop.fs.FileStatus)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFileDeletable</h4> +<pre>public boolean isFileDeletable(org.apache.hadoop.fs.FileStatus fStat)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html#isFileDeletable(org.apache.hadoop.fs.FileStatus)">BaseFileCleanerDelegate</a></code></strong></div> +<div class="block">Should the master delete the file or keep it?</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html#isFileDeletable(org.apache.hadoop.fs.FileStatus)">isFileDeletable</a></code> in class <code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">BaseFileCleanerDelegate</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>fStat</code> - file status of the file to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if the file is deletable, <tt>false</tt> if not</dd></dl> +</li> +</ul> +<a name="setConf(org.apache.hadoop.conf.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConf</h4> +<pre>public void setConf(org.apache.hadoop.conf.Configuration config)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>setConf</code> in interface <code>org.apache.hadoop.conf.Configurable</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/BaseConfigurable.html#setConf(org.apache.hadoop.conf.Configuration)">setConf</a></code> in class <code><a href="../../../../../../org/apache/hadoop/hbase/BaseConfigurable.html" title="class in org.apache.hadoop.hbase">BaseConfigurable</a></code></dd> +</dl> +</li> +</ul> +<a name="stop(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> reason)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/hadoop/hbase/Stoppable.html#stop(java.lang.String)">Stoppable</a></code></strong></div> +<div class="block">Stop this service.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/Stoppable.html#stop(java.lang.String)">stop</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html#stop(java.lang.String)">stop</a></code> in class <code><a href="../../../../../../org/apache/hadoop/hbase/master/cleaner/BaseHFileCleanerDelegate.html" title="class in org.apache.hadoop.hbase.master.cleaner">BaseHFileCleanerDelegate</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>reason</code> - Why we're stopping.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LongTermArchivingHFileCleaner.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html" title="class in org.apache.hadoop.hbase.backup.example"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hadoop/hbase/backup/example/TableHFileArchiveTracker.html" title="class in org.apache.hadoop.hbase.backup.example"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html" target="_top">Frames</a></li> +<li><a href="LongTermArchivingHFileCleaner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>