blob: bc20e1280670bc3d9961e2179f6a0615e9db76c6 [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:17:33 PDT 2017 -->
<title>SftpFsHelper (gobblin-core 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="SftpFsHelper (gobblin-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/source/extractor/extract/sftp/SftpExtractor.html" title="class in gobblin.source.extractor.extract.sftp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.JSchLogger.html" title="class in gobblin.source.extractor.extract.sftp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/source/extractor/extract/sftp/SftpFsHelper.html" target="_top">Frames</a></li>
<li><a href="SftpFsHelper.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.source.extractor.extract.sftp</div>
<h2 title="Class SftpFsHelper" class="title">Class SftpFsHelper</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.source.extractor.extract.sftp.SftpFsHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">FileBasedHelper</a>, <a href="../../../../../gobblin/source/extractor/filebased/SizeAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">SizeAwareFileBasedHelper</a>, <a href="../../../../../gobblin/source/extractor/filebased/TimestampAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">TimestampAwareFileBasedHelper</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SftpFsHelper</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/source/extractor/filebased/TimestampAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">TimestampAwareFileBasedHelper</a></pre>
<div class="block">Connects to a source via SFTP and executes a given list of SFTP commands</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.JSchLogger.html" title="class in gobblin.source.extractor.extract.sftp">SftpFsHelper.JSchLogger</a></span></code>
<div class="block">Basic implementation of jsch.Logger that logs the output from the JSch commands to slf4j</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.MyUserInfo.html" title="class in gobblin.source.extractor.extract.sftp">SftpFsHelper.MyUserInfo</a></span></code>
<div class="block">Implementation of UserInfo class for JSch which allows for password-less login via keys</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.SftpGetMonitor.html" title="class in gobblin.source.extractor.extract.sftp">SftpFsHelper.SftpGetMonitor</a></span></code>
<div class="block">Implementation of an SftpProgressMonitor to monitor the progress of file downloads using the ChannelSftp.GET
methods</div>
</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#SftpFsHelper-gobblin.configuration.State-">SftpFsHelper</a></span>(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/State.html?is-external=true" title="class or interface in gobblin.configuration">State</a>&nbsp;state)</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#connect--">connect</a></span>()</code>
<div class="block">Opens up a connection to specified host using the username.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>com.jcraft.jsch.ChannelExec</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getExecChannel-java.lang.String-">getExecChannel</a></span>(<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;command)</code>
<div class="block">Create a new sftp channel to execute commands.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getFileMTime-java.lang.String-">getFileMTime</a></span>(<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;filePath)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getFileSize-java.lang.String-">getFileSize</a></span>(<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;filePath)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getFileStream-java.lang.String-">getFileStream</a></span>(<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;file)</code>
<div class="block">Executes a get SftpCommand and returns an input stream to the file</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>com.jcraft.jsch.ChannelSftp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getSftpChannel--">getSftpChannel</a></span>()</code>
<div class="block">Create new channel every time a command needs to be executed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>com.jcraft.jsch.ChannelSftp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getSftpConnection--">getSftpConnection</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getSftpChannel--"><code>getSftpChannel()</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#ls-java.lang.String-">ls</a></span>(<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;path)</code>&nbsp;</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SftpFsHelper-gobblin.configuration.State-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SftpFsHelper</h4>
<pre>public&nbsp;SftpFsHelper(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/configuration/State.html?is-external=true" title="class or interface in gobblin.configuration">State</a>&nbsp;state)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSftpConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSftpConnection</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;com.jcraft.jsch.ChannelSftp&nbsp;getSftpConnection()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.html#getSftpChannel--"><code>getSftpChannel()</code></a> instead.</span></div>
<div class="block">The method returns a new <code>ChannelSftp</code> without throwing an exception. Returns a null if any exception occurs
trying to get a new channel. The method exists for backward compatibility</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getSftpChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSftpChannel</h4>
<pre>public&nbsp;com.jcraft.jsch.ChannelSftp&nbsp;getSftpChannel()
throws com.jcraft.jsch.SftpException</pre>
<div class="block">Create new channel every time a command needs to be executed. This is required to support execution of multiple
commands in parallel. All created channels are cleaned up when the session is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <code>ChannelSftp</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>com.jcraft.jsch.SftpException</code></dd>
</dl>
</li>
</ul>
<a name="getExecChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecChannel</h4>
<pre>public&nbsp;com.jcraft.jsch.ChannelExec&nbsp;getExecChannel(<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;command)
throws com.jcraft.jsch.SftpException</pre>
<div class="block">Create a new sftp channel to execute commands.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - to execute on the remote machine</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new execution channel</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>com.jcraft.jsch.SftpException</code> - if a channel could not be opened</dd>
</dl>
</li>
</ul>
<a name="connect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public&nbsp;void&nbsp;connect()
throws <a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></pre>
<div class="block">Opens up a connection to specified host using the username. Connects to the source using a private key without
prompting for a password. This method does not support connecting to a source using a password, only by private
key</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html#connect--">connect</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">FileBasedHelper</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></code></dd>
</dl>
</li>
</ul>
<a name="getFileStream-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileStream</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;getFileStream(<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;file)
throws <a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></pre>
<div class="block">Executes a get SftpCommand and returns an input stream to the file</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html#getFileStream-java.lang.String-">getFileStream</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">FileBasedHelper</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cmd</code> - is the command to execute</dd>
<dd><code>sftp</code> - is the channel to execute the command on</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>com.jcraft.jsch.SftpException</code></dd>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></code></dd>
</dl>
</li>
</ul>
<a name="ls-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ls</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;ls(<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;path)
throws <a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html#ls-java.lang.String-">ls</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">FileBasedHelper</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="getFileSize-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileSize</h4>
<pre>public&nbsp;long&nbsp;getFileSize(<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;filePath)
throws <a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/SizeAwareFileBasedHelper.html#getFileSize-java.lang.String-">getFileSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../gobblin/source/extractor/filebased/SizeAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">SizeAwareFileBasedHelper</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></code></dd>
</dl>
</li>
</ul>
<a name="getFileMTime-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFileMTime</h4>
<pre>public&nbsp;long&nbsp;getFileMTime(<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;filePath)
throws <a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/TimestampAwareFileBasedHelper.html#getFileMTime-java.lang.String-">getFileMTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../gobblin/source/extractor/filebased/TimestampAwareFileBasedHelper.html" title="interface in gobblin.source.extractor.filebased">TimestampAwareFileBasedHelper</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../gobblin/source/extractor/filebased/FileBasedHelperException.html" title="class in gobblin.source.extractor.filebased">FileBasedHelperException</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/source/extractor/extract/sftp/SftpExtractor.html" title="class in gobblin.source.extractor.extract.sftp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../gobblin/source/extractor/extract/sftp/SftpFsHelper.JSchLogger.html" title="class in gobblin.source.extractor.extract.sftp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/source/extractor/extract/sftp/SftpFsHelper.html" target="_top">Frames</a></li>
<li><a href="SftpFsHelper.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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>