blob: 9a8d822fb2269c6bbff1575340c6b969f30f41cc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
<title>org.eclipse.ecf.filetransfer (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="dc.created" content="2021-06-15">
<meta name="description" content="declaration: package: org.eclipse.ecf.filetransfer">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="package-declaration">
<script type="text/javascript">var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.ecf.filetransfer</h1>
</div>
<div class="contentContainer">
<section class="summary">
<ul class="blockList">
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a></th>
<td class="colLast">
<div class="block">An object that describes a file range specification.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></th>
<td class="colLast">
<div class="block">File transfer super interface.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IFileTransferInfo.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferInfo</a></th>
<td class="colLast">
<div class="block">File transfer information delivered to
<a href="IIncomingFileTransferRequestListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IIncomingFileTransferRequestListener</code></a> via an event implementing
<a href="events/IFileTransferRequestEvent.html#getFileTransferInfo()"><code>IFileTransferRequestEvent.getFileTransferInfo()</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a></th>
<td class="colLast">
<div class="block">Listener for handling file transfer events.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferPausable</a></th>
<td class="colLast">
<div class="block">Adapter interface for pausing and resuming IFileTransfer instances that
expose this adapter interface via
<code>IAdaptable.getAdapter(Class adapter)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IFileTransferRateControl.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferRateControl</a></th>
<td class="colLast">
<div class="block">Adapter for setting rate control on IFileTransferInfo instances that expose
expose this adapter interface via
<code>IAdaptable.getAdapter(Class adapter)</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IFileTransferRunnable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferRunnable</a></th>
<td class="colLast">
<div class="block">Runnable for doing file transfer.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></th>
<td class="colLast">
<div class="block">Incoming file transfer request.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IIncomingFileTransferRequestListener.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransferRequestListener</a></th>
<td class="colLast">
<div class="block">Listener for incoming file transfer requests.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IOutgoingFileTransfer</a></th>
<td class="colLast">
<div class="block">Outgoing file transfer.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IRemoteFile.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFile</a></th>
<td class="colLast">
<div class="block">Remote file representation.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IRemoteFileAttributes.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileAttributes</a></th>
<td class="colLast">
<div class="block">Remote file attributes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IRemoteFileInfo.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileInfo</a></th>
<td class="colLast">
<div class="block">Information about a remote file.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IRemoteFileSystemBrowserContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemBrowserContainerAdapter</a></th>
<td class="colLast">
<div class="block">Remote file system browser adapter.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a></th>
<td class="colLast">
<div class="block">Listener for handling events associated with remote file
browsing activities.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></th>
<td class="colLast">
<div class="block">Remote file request.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></th>
<td class="colLast">
<div class="block">Entry point retrieval file transfer adapter.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IRetrieveFileTransferOptions.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferOptions</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISendFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">ISendFileTransferContainerAdapter</a></th>
<td class="colLast">
<div class="block">Entry point outgoing file transfer container adapter.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISendFileTransferOptions.html" title="interface in org.eclipse.ecf.filetransfer">ISendFileTransferOptions</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileTransferInfo.html" title="class in org.eclipse.ecf.filetransfer">FileTransferInfo</a></th>
<td class="colLast">
<div class="block">File transfer information delivered to
<a href="IIncomingFileTransferRequestListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IIncomingFileTransferRequestListener</code></a> via an event implementing
<a href="events/IFileTransferRequestEvent.html#getFileTransferInfo()"><code>IFileTransferRequestEvent.getFileTransferInfo()</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a></th>
<td class="colLast">
<div class="block"><code>Job</code> subclass for executing file transfers.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BrowseFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">BrowseFileTransferException</a></th>
<td class="colLast">
<div class="block">Exception thrown upon browse problem</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></th>
<td class="colLast">
<div class="block">Exception thrown upon incoming file transfer problem</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InvalidFileRangeSpecificationException.html" title="class in org.eclipse.ecf.filetransfer">InvalidFileRangeSpecificationException</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RemoteFileSystemException.html" title="class in org.eclipse.ecf.filetransfer">RemoteFileSystemException</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SendFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">SendFileTransferException</a></th>
<td class="colLast">
<div class="block">Outgoing file transfer exception</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer">UserCancelledException</a></th>
<td class="colLast">
<div class="block">Exception class for user cancellation</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>