blob: 9d6879d02ac4fd3000cd2f10bbc3292d325825dd [file] [log] [blame]
<!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 (1.8.0_40) on Thu Jul 20 13:18:48 PDT 2017 -->
<title>Trash (gobblin-data-management 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Trash (gobblin-data-management 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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="../../../../gobblin/data/management/trash/TimeBasedSnapshotCleanupPolicy.html" title="class in gobblin.data.management.trash"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/data/management/trash/TrashFactory.html" title="class in gobblin.data.management.trash"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/data/management/trash/Trash.html" target="_top">Frames</a></li>
<li><a href="Trash.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">gobblin.data.management.trash</div>
<h2 title="Class Trash" class="title">Class Trash</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://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>gobblin.data.management.trash.Trash</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../gobblin/data/management/trash/GobblinTrash.html" title="interface in gobblin.data.management.trash">GobblinTrash</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../gobblin/data/management/trash/ProxiedTrash.html" title="class in gobblin.data.management.trash">ProxiedTrash</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Trash</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../gobblin/data/management/trash/GobblinTrash.html" title="interface in gobblin.data.management.trash">GobblinTrash</a></pre>
<div class="block">Flexible implementation of Trash similar to Hadoop trash. Allows for injecting cleanup policies for snapshots.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#DEFAULT_TRASH_DIRECTORY">DEFAULT_TRASH_DIRECTORY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#fs">fs</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#SNAPSHOT_CLEANUP_POLICY_CLASS_KEY">SNAPSHOT_CLEANUP_POLICY_CLASS_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_IDENTIFIER_FILE">TRASH_IDENTIFIER_FILE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_LOCATION_KEY">TRASH_LOCATION_KEY</a></span></code>
<div class="block">Location of trash directory in file system.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/PathFilter.html?is-external=true" title="class or interface in org.apache.hadoop.fs">PathFilter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_NOT_SNAPSHOT_PATH_FILTER">TRASH_NOT_SNAPSHOT_PATH_FILTER</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.joda.time.format.DateTimeFormatter</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_SNAPSHOT_NAME_FORMATTER">TRASH_SNAPSHOT_NAME_FORMATTER</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/PathFilter.html?is-external=true" title="class or interface in org.apache.hadoop.fs">PathFilter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_SNAPSHOT_PATH_FILTER">TRASH_SNAPSHOT_PATH_FILTER</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_SNAPSHOT_PREFIX">TRASH_SNAPSHOT_PREFIX</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#Trash-org.apache.hadoop.fs.FileSystem-">Trash</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../gobblin/data/management/trash/TrashFactory.html" title="class in gobblin.data.management.trash"><code>TrashFactory</code></a>.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#Trash-org.apache.hadoop.fs.FileSystem-java.util.Properties-">Trash</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../gobblin/data/management/trash/TrashFactory.html" title="class in gobblin.data.management.trash"><code>TrashFactory</code></a>.</span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#Trash-org.apache.hadoop.fs.FileSystem-java.util.Properties-java.lang.String-">Trash</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#createTrashLocation-org.apache.hadoop.fs.FileSystem-java.util.Properties-java.lang.String-">createTrashLocation</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</code>
<div class="block">Create location of Trash directory.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#createTrashSnapshot--">createTrashSnapshot</a></span>()</code>
<div class="block">Moves all current contents of trash directory into a snapshot directory with current timestamp.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#ensureTrashLocationExists-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">ensureTrashLocationExists</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;trashLocation)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#getTrashLocation--">getTrashLocation</a></span>()</code>
<div class="block">Get trash location.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#moveToTrash-org.apache.hadoop.fs.Path-">moveToTrash</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path)</code>
<div class="block">Move a path to trash.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/trash/Trash.html#purgeTrashSnapshots--">purgeTrashSnapshots</a></span>()</code>
<div class="block">For each existing trash snapshot, uses a <a href="../../../../gobblin/data/management/trash/SnapshotCleanupPolicy.html" title="interface in gobblin.data.management.trash"><code>SnapshotCleanupPolicy</code></a> to determine whether
the snapshot should be deleted.</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&nbsp;java.lang.<a href="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TRASH_LOCATION_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRASH_LOCATION_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TRASH_LOCATION_KEY</pre>
<div class="block">Location of trash directory in file system. The location can include a token $USER that will be automatically
replaced by the name of the active user.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#gobblin.data.management.trash.Trash.TRASH_LOCATION_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SNAPSHOT_CLEANUP_POLICY_CLASS_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SNAPSHOT_CLEANUP_POLICY_CLASS_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SNAPSHOT_CLEANUP_POLICY_CLASS_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#gobblin.data.management.trash.Trash.SNAPSHOT_CLEANUP_POLICY_CLASS_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TRASH_SNAPSHOT_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRASH_SNAPSHOT_PREFIX</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TRASH_SNAPSHOT_PREFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#gobblin.data.management.trash.Trash.TRASH_SNAPSHOT_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TRASH_IDENTIFIER_FILE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRASH_IDENTIFIER_FILE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TRASH_IDENTIFIER_FILE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#gobblin.data.management.trash.Trash.TRASH_IDENTIFIER_FILE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TRASH_DIRECTORY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TRASH_DIRECTORY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_TRASH_DIRECTORY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#gobblin.data.management.trash.Trash.DEFAULT_TRASH_DIRECTORY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TRASH_SNAPSHOT_NAME_FORMATTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRASH_SNAPSHOT_NAME_FORMATTER</h4>
<pre>public static final&nbsp;org.joda.time.format.DateTimeFormatter TRASH_SNAPSHOT_NAME_FORMATTER</pre>
</li>
</ul>
<a name="TRASH_SNAPSHOT_PATH_FILTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRASH_SNAPSHOT_PATH_FILTER</h4>
<pre>public static final&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/PathFilter.html?is-external=true" title="class or interface in org.apache.hadoop.fs">PathFilter</a> TRASH_SNAPSHOT_PATH_FILTER</pre>
</li>
</ul>
<a name="TRASH_NOT_SNAPSHOT_PATH_FILTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRASH_NOT_SNAPSHOT_PATH_FILTER</h4>
<pre>public static final&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/PathFilter.html?is-external=true" title="class or interface in org.apache.hadoop.fs">PathFilter</a> TRASH_NOT_SNAPSHOT_PATH_FILTER</pre>
</li>
</ul>
<a name="fs">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fs</h4>
<pre>protected final&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a> fs</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Trash-org.apache.hadoop.fs.FileSystem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Trash</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;Trash(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs)
throws <a href="https://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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../gobblin/data/management/trash/TrashFactory.html" title="class in gobblin.data.management.trash"><code>TrashFactory</code></a>.</span></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="Trash-org.apache.hadoop.fs.FileSystem-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Trash</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;Trash(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)
throws <a href="https://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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../gobblin/data/management/trash/TrashFactory.html" title="class in gobblin.data.management.trash"><code>TrashFactory</code></a>.</span></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="Trash-org.apache.hadoop.fs.FileSystem-java.util.Properties-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Trash</h4>
<pre>protected&nbsp;Trash(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTrashLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrashLocation</h4>
<pre>public&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;getTrashLocation()
throws <a href="https://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">Get trash location.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> for trash directory.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="createTrashLocation-org.apache.hadoop.fs.FileSystem-java.util.Properties-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTrashLocation</h4>
<pre>protected&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;createTrashLocation(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)
throws <a href="https://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">Create location of Trash directory. Parsed from props at key <a href="../../../../gobblin/data/management/trash/Trash.html#TRASH_LOCATION_KEY"><code>TRASH_LOCATION_KEY</code></a>, defaulting to
/home/directory/_GOBBLIN_TRASH.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fs</code> - <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a> where trash should be found.</dd>
<dd><code>props</code> - <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> containing trash configuration.</dd>
<dd><code>user</code> - If the trash location contains the token $USER, the token will be replaced by the value of user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> for trash directory.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="ensureTrashLocationExists-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ensureTrashLocationExists</h4>
<pre>protected&nbsp;void&nbsp;ensureTrashLocationExists(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;trashLocation)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="moveToTrash-org.apache.hadoop.fs.Path-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveToTrash</h4>
<pre>public&nbsp;boolean&nbsp;moveToTrash(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path)
throws <a href="https://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">Move a path to trash. The absolute path of the input path will be replicated under the trash directory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/data/management/trash/GobblinTrash.html#moveToTrash-org.apache.hadoop.fs.Path-">moveToTrash</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/data/management/trash/GobblinTrash.html" title="interface in gobblin.data.management.trash">GobblinTrash</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a> path to move to trash.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if move to trash was done successfully.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="createTrashSnapshot--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTrashSnapshot</h4>
<pre>public&nbsp;void&nbsp;createTrashSnapshot()
throws <a href="https://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">Moves all current contents of trash directory into a snapshot directory with current timestamp.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="purgeTrashSnapshots--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>purgeTrashSnapshots</h4>
<pre>public&nbsp;void&nbsp;purgeTrashSnapshots()
throws <a href="https://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">For each existing trash snapshot, uses a <a href="../../../../gobblin/data/management/trash/SnapshotCleanupPolicy.html" title="interface in gobblin.data.management.trash"><code>SnapshotCleanupPolicy</code></a> to determine whether
the snapshot should be deleted. If so, delete it permanently.
<p>
Each existing snapshot will be passed to <a href="../../../../gobblin/data/management/trash/SnapshotCleanupPolicy.html#shouldDeleteSnapshot-org.apache.hadoop.fs.FileStatus-gobblin.data.management.trash.Trash-"><code>SnapshotCleanupPolicy.shouldDeleteSnapshot(org.apache.hadoop.fs.FileStatus, gobblin.data.management.trash.Trash)</code></a>
from oldest to newest, and will be deleted if the method returns true.
</p></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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="../../../../gobblin/data/management/trash/TimeBasedSnapshotCleanupPolicy.html" title="class in gobblin.data.management.trash"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/data/management/trash/TrashFactory.html" title="class in gobblin.data.management.trash"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/data/management/trash/Trash.html" target="_top">Frames</a></li>
<li><a href="Trash.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>