| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>AbstractRetrieveFileTransfer (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.provider.filetransfer.retrieve, class: AbstractRetrieveFileTransfer"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.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="class-declaration"> |
| <script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":6,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":6,"i53":10,"i54":9,"i55":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractRetrieveFileTransfer.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> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ecf.provider.filetransfer.retrieve</a></div> |
| <h1 title="Class AbstractRetrieveFileTransfer" class="title">Class AbstractRetrieveFileTransfer</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../../../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code>, <code><a href="../../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code>, <code><a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferPausable</a></code>, <code><a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code>, <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></code>, <code><a href="../../../filetransfer/service/IRetrieveFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer.service">IRetrieveFileTransfer</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../httpclient4/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient4">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../httpclient45/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient45">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../httpclient5/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient5">HttpClientRetrieveFileTransfer</a></code>, <code><a href="UrlConnectionRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">UrlConnectionRetrieveFileTransfer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractRetrieveFileTransfer</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a>, <a href="../../../filetransfer/service/IRetrieveFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer.service">IRetrieveFileTransfer</a>, <a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferPausable</a></pre> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buff_length">buff_length</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bytesReceived">bytesReceived</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CLOSE_TIMEOUT">CLOSE_TIMEOUT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeOutputStream">closeOutputStream</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectContext">connectContext</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_BUF_LENGTH">DEFAULT_BUF_LENGTH</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#done">done</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#downloadRateBytesPerSecond">downloadRateBytesPerSecond</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exception">exception</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fileLength">fileLength</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.core.runtime.jobs.Job</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#job">job</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jobLock">jobLock</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lastModifiedTime">lastModifiedTime</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listener">listener</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localFileContents">localFileContents</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#options">options</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#paused">paused</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#POLLING_RETRY_ATTEMPTS">POLLING_RETRY_ATTEMPTS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proxy">proxy</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rangeSpecification">rangeSpecification</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#READ_TIMEOUT">READ_TIMEOUT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteFileContents">remoteFileContents</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteFileID">remoteFileID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteFileURL">remoteFileURL</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#responseHeaders">responseHeaders</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TIMEOUT_INPUTSTREAM_BUFFER_SIZE">TIMEOUT_INPUTSTREAM_BUFFER_SIZE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferStartTime">transferStartTime</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractRetrieveFileTransfer</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Cancel this file transfer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createJobName()">createJobName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRangeName()">createRangeName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>protected abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doPause()">doPause</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Subclass overridable version of <a href="#pause()"><code>pause()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>protected abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doResume()">doResume</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Subclass overridable version of <a href="#resume()"><code>resume()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireReceiveResumedEvent()">fireReceiveResumedEvent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireReceiveStartEvent()">fireReceiveStartEvent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireTransferReceiveDataEvent()">fireTransferReceiveDataEvent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireTransferReceiveDoneEvent()">fireTransferReceiveDoneEvent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireTransferReceivePausedEvent()">fireTransferReceivePausedEvent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdapter(java.lang.Class)">getAdapter</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> adapter)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytesReceived()">getBytesReceived</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get number of bytes received so far.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getException()">getException</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get any exception associated with this file transfer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileLength()">getFileLength</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return resulting file length (in bytes) for this file transfer instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code><a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileRangeSpecification()">getFileRangeSpecification</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get file range specification for this incoming file transfer instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>protected org.eclipse.core.runtime.IStatus</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFinalStatus(java.lang.Throwable)">getFinalStatus</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> exception1)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code><a href="../../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getID()">getID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the ID for this 'identifiable' object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code><a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListener()">getListener</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get listener assigned to this incoming file transfer.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptions()">getOptions</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPercentComplete()">getPercentComplete</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the percent complete for this file transfer.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteFileName()">getRemoteFileName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Obtains the name of the remote file if possible.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteFileURL()">getRemoteFileURL</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteLastModified()">getRemoteLastModified</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Obtains the timestamp that reflects the time when the remote file was last |
| modified if possible.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code><a href="../../../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRetrieveNamespace()">getRetrieveNamespace</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get namespace to be used for creation of remoteFileID for retrieve |
| request.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSocketCloseTimeout()">getSocketCloseTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSocketReadTimeout()">getSocketReadTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i26"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleReceivedData(byte%5B%5D,int,double,org.eclipse.core.runtime.IProgressMonitor)">handleReceivedData</a></span>​(byte[] buf, |
| int bytes, |
| double factor, |
| org.eclipse.core.runtime.IProgressMonitor monitor)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hardClose()">hardClose</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i28"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCanceled()">isCanceled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i29"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDone()">isDone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if this file transfer is done, false if not yet completed.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPaused()">isPaused</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code>protected <a href="../../../filetransfer/UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer">UserCancelledException</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newUserCancelledException()">newUserCancelledException</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openStreams()">openStreams</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Open incoming and outgoing streams associated with this file transfer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pause()">pause</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Pause file transfer.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i34"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetDoneAndException()">resetDoneAndException</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resume()">resume</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resume file transfer after having been paused.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <td class="colFirst"><code>protected org.eclipse.core.net.proxy.IProxyData</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData%5B%5D)">selectProxyFromProxies</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> protocol, |
| org.eclipse.core.net.proxy.IProxyData[] proxies)</code></th> |
| <td class="colLast"> |
| <div class="block">Select a single proxy from a set of proxies available for the given host.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a></span>​(<a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> rFileID, |
| <a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a> rangeSpec, |
| <a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a> transferListener, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a> ops)</code></th> |
| <td class="colLast"> |
| <div class="block">Send request for transfer of a remote file to local file storage.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a></span>​(<a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> remoteFileID1, |
| <a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a> transferListener, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a> options1)</code></th> |
| <td class="colLast"> |
| <div class="block">Send request for transfer of a remote file to local file storage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCloseOutputStream(boolean)">setCloseOutputStream</a></span>​(boolean close)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i40"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></span>​(<a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Set connect context for authentication upon subsequent |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i41"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDone(boolean)">setDone</a></span>​(boolean done)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i42"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDoneCanceled()">setDoneCanceled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i43"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDoneCanceled(java.lang.Exception)">setDoneCanceled</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a> e)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i44"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDoneException(java.lang.Exception)">setDoneException</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a> e)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i45"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFileLength(long)">setFileLength</a></span>​(long length)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i46"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInputStream(java.io.InputStream)">setInputStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> ins)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i47"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLastModifiedTime(long)">setLastModifiedTime</a></span>​(long timestamp)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i48"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOutputStream(java.io.OutputStream)">setOutputStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> outs)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i49"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a></span>​(<a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</code></th> |
| <td class="colLast"> |
| <div class="block">Set proxy for use upon subsequent |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i50"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupAndScheduleJob(org.eclipse.ecf.filetransfer.FileTransferJob)">setupAndScheduleJob</a></span>​(<a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> fileTransferJob)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i51"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupProxies()">setupProxies</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i52"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></span>​(<a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</code></th> |
| <td class="colLast"> |
| <div class="block">Setup ECF proxy.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i53"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#targetHasGzSuffix(java.lang.String)">targetHasGzSuffix</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> target)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i54"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toHumanReadableBytes(double)">toHumanReadableBytes</a></span>​(double size)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i55"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapTransferReadInputStream(java.io.InputStream,org.eclipse.core.runtime.IProgressMonitor)">wrapTransferReadInputStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> inputStream, |
| org.eclipse.core.runtime.IProgressMonitor monitor)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="DEFAULT_BUF_LENGTH">DEFAULT_BUF_LENGTH</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType">int</span> <span class="memberName">DEFAULT_BUF_LENGTH</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer.DEFAULT_BUF_LENGTH">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="POLLING_RETRY_ATTEMPTS">POLLING_RETRY_ATTEMPTS</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">POLLING_RETRY_ATTEMPTS</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="TIMEOUT_INPUTSTREAM_BUFFER_SIZE">TIMEOUT_INPUTSTREAM_BUFFER_SIZE</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">TIMEOUT_INPUTSTREAM_BUFFER_SIZE</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer.TIMEOUT_INPUTSTREAM_BUFFER_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="READ_TIMEOUT">READ_TIMEOUT</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">READ_TIMEOUT</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="CLOSE_TIMEOUT">CLOSE_TIMEOUT</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">CLOSE_TIMEOUT</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="jobLock">jobLock</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></span> <span class="memberName">jobLock</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="job">job</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.eclipse.core.runtime.jobs.Job</span> <span class="memberName">job</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteFileURL">remoteFileURL</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></span> <span class="memberName">remoteFileURL</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteFileID">remoteFileID</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a></span> <span class="memberName">remoteFileID</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="listener">listener</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a></span> <span class="memberName">listener</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="buff_length">buff_length</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">int</span> <span class="memberName">buff_length</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="done">done</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">done</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="bytesReceived">bytesReceived</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected volatile</span> <span class="returnType">long</span> <span class="memberName">bytesReceived</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteFileContents">remoteFileContents</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></span> <span class="memberName">remoteFileContents</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="localFileContents">localFileContents</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a></span> <span class="memberName">localFileContents</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="closeOutputStream">closeOutputStream</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">closeOutputStream</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="exception">exception</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></span> <span class="memberName">exception</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fileLength">fileLength</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">long</span> <span class="memberName">fileLength</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="lastModifiedTime">lastModifiedTime</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">long</span> <span class="memberName">lastModifiedTime</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="options">options</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></span> <span class="memberName">options</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="paused">paused</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">paused</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="rangeSpecification">rangeSpecification</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a></span> <span class="memberName">rangeSpecification</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="proxy">proxy</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a></span> <span class="memberName">proxy</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connectContext">connectContext</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></span> <span class="memberName">connectContext</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="transferStartTime">transferStartTime</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">long</span> <span class="memberName">transferStartTime</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="downloadRateBytesPerSecond">downloadRateBytesPerSecond</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">double</span> <span class="memberName">downloadRateBytesPerSecond</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="responseHeaders">responseHeaders</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></span> <span class="memberName">responseHeaders</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>()">AbstractRetrieveFileTransfer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">AbstractRetrieveFileTransfer</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="wrapTransferReadInputStream(java.io.InputStream,org.eclipse.core.runtime.IProgressMonitor)">wrapTransferReadInputStream</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></span> <span class="memberName">wrapTransferReadInputStream</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> inputStream, |
| org.eclipse.core.runtime.IProgressMonitor monitor)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteFileURL()">getRemoteFileURL</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></span> <span class="memberName">getRemoteFileURL</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSocketReadTimeout()">getSocketReadTimeout</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">int</span> <span class="memberName">getSocketReadTimeout</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSocketCloseTimeout()">getSocketCloseTimeout</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">int</span> <span class="memberName">getSocketCloseTimeout</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setInputStream(java.io.InputStream)">setInputStream</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setInputStream</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> ins)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setOutputStream(java.io.OutputStream)">setOutputStream</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setOutputStream</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> outs)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setCloseOutputStream(boolean)">setCloseOutputStream</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setCloseOutputStream</span>​(<span class="arguments">boolean close)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setFileLength(long)">setFileLength</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setFileLength</span>​(<span class="arguments">long length)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setLastModifiedTime(long)">setLastModifiedTime</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setLastModifiedTime</span>​(<span class="arguments">long timestamp)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOptions()">getOptions</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></span> <span class="memberName">getOptions</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="handleReceivedData(byte[],int,double,org.eclipse.core.runtime.IProgressMonitor)">handleReceivedData</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">handleReceivedData</span>​(<span class="arguments">byte[] buf, |
| int bytes, |
| double factor, |
| org.eclipse.core.runtime.IProgressMonitor monitor)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></span></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toHumanReadableBytes(double)">toHumanReadableBytes</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toHumanReadableBytes</span>​(<span class="arguments">double size)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getID()">getID</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">getID</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../core/identity/IIdentifiable.html#getID()">IIdentifiable</a></code></span></div> |
| <div class="block">Return the ID for this 'identifiable' object. The returned ID should be |
| unique within its namespace. May return <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../core/identity/IIdentifiable.html#getID()">getID</a></code> in interface <code><a href="../../../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ID for this identifiable object. May return <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFinalStatus(java.lang.Throwable)">getFinalStatus</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.eclipse.core.runtime.IStatus</span> <span class="memberName">getFinalStatus</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> exception1)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="hardClose()">hardClose</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">hardClose</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireTransferReceivePausedEvent()">fireTransferReceivePausedEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireTransferReceivePausedEvent</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireTransferReceiveDoneEvent()">fireTransferReceiveDoneEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireTransferReceiveDoneEvent</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireTransferReceiveDataEvent()">fireTransferReceiveDataEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireTransferReceiveDataEvent</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setConnectContextForAuthentication</span>​(<span class="arguments"><a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">IRetrieveFileTransferContainerAdapter</a></code></span></div> |
| <div class="block">Set connect context for authentication upon subsequent |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>. This |
| method should be called with a non-null connectContext in order to allow |
| authentication to occur during call to |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></code> in interface <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectContext</code> - the connect context to use for authenticating during |
| subsequent call to |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>. |
| If <code>null</code>, then no authentication will be |
| attempted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setProxy</span>​(<span class="arguments"><a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#setProxy(org.eclipse.ecf.core.util.Proxy)">IRetrieveFileTransferContainerAdapter</a></code></span></div> |
| <div class="block">Set proxy for use upon subsequent |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>. This |
| method should be called with proxy to allow the given proxy to |
| be used in subsequent calls to |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>. |
| <p> |
| When proxy is <code>null</code> or has not been called providers must use |
| the <code>org.eclipse.core.net</code> proxy API to obtain proxy information |
| and proxy credentials if they support proxies of the type(s) supported by |
| that API. The API is provided by an OSGi service of type |
| <code>org.eclipse.core.net.proxy.IProxyService</code>. |
| </p><p> |
| If no information is available via <code>IProxyService</code> |
| providers may use other defaults. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a></code> in interface <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>proxy</code> - the proxy to use for subsequent calls to |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>. |
| If <code>null</code>, then proxy information is obtained from |
| <code>IProxyService</code> if available. Otherwise provider |
| defined defaults may be used.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getBytesReceived()">getBytesReceived</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">long</span> <span class="memberName">getBytesReceived</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IIncomingFileTransfer.html#getBytesReceived()">IIncomingFileTransfer</a></code></span></div> |
| <div class="block">Get number of bytes received so far. If provider does not support |
| reporting the number of bytes received, will return -1.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IIncomingFileTransfer.html#getBytesReceived()">getBytesReceived</a></code> in interface <code><a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long number of bytes received. Returns -1 if provider does not |
| support reporting of number of bytes received during transfer</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="newUserCancelledException()">newUserCancelledException</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../filetransfer/UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer">UserCancelledException</a></span> <span class="memberName">newUserCancelledException</span>()</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>UserCancelledException if some user cancellation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="resetDoneAndException()">resetDoneAndException</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">resetDoneAndException</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setDone(boolean)">setDone</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setDone</span>​(<span class="arguments">boolean done)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setDoneException(java.lang.Exception)">setDoneException</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setDoneException</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a> e)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isCanceled()">isCanceled</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">isCanceled</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setDoneCanceled()">setDoneCanceled</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setDoneCanceled</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setDoneCanceled(java.lang.Exception)">setDoneCanceled</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setDoneCanceled</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a> e)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cancel()">cancel</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">cancel</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransfer.html#cancel()">IFileTransfer</a></code></span></div> |
| <div class="block">Cancel this file transfer. If file transfer has already been completed, |
| then this method has no effect. If the file transfer has not been |
| completed then calling this method will result in an |
| <a href="../../../filetransfer/events/IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events"><code>IFileTransferEvent</code></a> being delivered to the |
| <a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileTransferListener</code></a> indicating that transfer is done (<a href="../../../filetransfer/IFileTransfer.html#isDone()"><code>IFileTransfer.isDone()</code></a> |
| returns true), and some exception will be made available</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransfer.html#cancel()">cancel</a></code> in interface <code><a href="../../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getException()">getException</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></span> <span class="memberName">getException</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransfer.html#getException()">IFileTransfer</a></code></span></div> |
| <div class="block">Get any exception associated with this file transfer. The value returned |
| from this method is valid only if <a href="../../../filetransfer/IFileTransfer.html#isDone()"><code>IFileTransfer.isDone()</code></a> method returns true. |
| If the file transfer completed successfully, <a href="../../../filetransfer/IFileTransfer.html#isDone()"><code>IFileTransfer.isDone()</code></a> will |
| return true, and this method will return null. If the file transfer |
| completed unsuccessfully (some exception occurred), then |
| <a href="../../../filetransfer/IFileTransfer.html#isDone()"><code>IFileTransfer.isDone()</code></a> will return true, and this method will return a |
| non-null Exception instance that occurred. |
| <p> |
| If the the file transfer was canceled by the user, then the exception |
| returned will be an instance of <a href="../../../filetransfer/UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer"><code>UserCancelledException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransfer.html#getException()">getException</a></code> in interface <code><a href="../../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Exception associated with this file transfer. <code>null</code> |
| if transfer completed successfully, non-null if transfer |
| completed with some exception. Only valid <b>after</b> |
| <a href="../../../filetransfer/IFileTransfer.html#isDone()"><code>IFileTransfer.isDone()</code></a> returns true.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getPercentComplete()">getPercentComplete</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">double</span> <span class="memberName">getPercentComplete</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransfer.html#getPercentComplete()">IFileTransfer</a></code></span></div> |
| <div class="block">Get the percent complete for this file transfer. The returned value will |
| be either -1.0, meaning that the underlying provider does not support |
| reporting percent complete for this file transfer, or a value between 0 |
| and 1 reflecting the percent complete for this file transfer. If 0.0 no |
| data has been sent, if 1.0, the file transfer is 100 percent complete. |
| |
| The value returned from this method should <b>not</b> be used to |
| determine whether the transfer has completed, as it may not show |
| completion in the event of an transfer failure. Note that the |
| <a href="../../../filetransfer/IFileTransfer.html#isDone()"><code>IFileTransfer.isDone()</code></a> method should be consulted to determine if the file |
| transfer has completed (with or without error).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransfer.html#getPercentComplete()">getPercentComplete</a></code> in interface <code><a href="../../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>double percent complete. Returns -1.0 if the underlying provider |
| does not support reporting percentage complete, or between 0 and |
| 1 to indicate actual percent complete for this file transfer</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFileLength()">getFileLength</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">long</span> <span class="memberName">getFileLength</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransfer.html#getFileLength()">IFileTransfer</a></code></span></div> |
| <div class="block">Return resulting file length (in bytes) for this file transfer instance. If the length is not known, |
| -1 will be returned. Note that if a <a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileRangeSpecification</code></a> is provided that the returned |
| file length is the expected file length of just the range retrieved (and not the entire file).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransfer.html#getFileLength()">getFileLength</a></code> in interface <code><a href="../../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long file length</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteLastModified()">getRemoteLastModified</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></span> <span class="memberName">getRemoteLastModified</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IIncomingFileTransfer.html#getRemoteLastModified()">IIncomingFileTransfer</a></code></span></div> |
| <div class="block">Obtains the timestamp that reflects the time when the remote file was last |
| modified if possible.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IIncomingFileTransfer.html#getRemoteLastModified()">getRemoteLastModified</a></code> in interface <code><a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The time the remote file was last modified or <code>null</code> if that |
| information was not available.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isDone()">isDone</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isDone</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransfer.html#isDone()">IFileTransfer</a></code></span></div> |
| <div class="block">Return true if this file transfer is done, false if not yet completed. |
| The file transfer can be completed successfully, or an exception can |
| occur and the file transfer will have failed. In either case of |
| successful or unsuccessful transfer, this method will return true when |
| the file transfer is complete. To determine whether the transfer |
| completed <b>successfully</b>, it is necessary to also consult the |
| <a href="../../../filetransfer/IFileTransfer.html#getException()"><code>IFileTransfer.getException()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransfer.html#isDone()">isDone</a></code> in interface <code><a href="../../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean true if file transfer is done, false if file transfer is |
| still in progress.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAdapter(java.lang.Class)">getAdapter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><T></span> <span class="returnType">T</span> <span class="memberName">getAdapter</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> adapter)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getAdapter</code> in interface <code>org.eclipse.core.runtime.IAdaptable</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="openStreams()">openStreams</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected abstract</span> <span class="returnType">void</span> <span class="memberName">openStreams</span>() |
| throws <span class="exceptions"><a href="../../../filetransfer/IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></span></div> |
| <div class="block">Open incoming and outgoing streams associated with this file transfer. |
| Subclasses must implement this method to open input and output streams. |
| The <code>remoteFileContents</code> and <code>localFileContent</code> |
| must be non-<code>null</code> after successful completion of the |
| implementation of this method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../filetransfer/IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></code> - if some problem</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">sendRetrieveRequest</span>​(<span class="arguments"><a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> remoteFileID1, |
| <a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a> transferListener, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a> options1)</span> |
| throws <span class="exceptions"><a href="../../../filetransfer/IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">IRetrieveFileTransferContainerAdapter</a></code></span></div> |
| <div class="block">Send request for transfer of a remote file to local file storage. This |
| method is used to initiate a file retrieve for a remoteFileID (first |
| parameter). File transfer events are asynchronously delivered a file |
| transfer listener (second parameter). The given remoteFileID and |
| transferListener must not be null. |
| <p> |
| <b>NOTE</b>: if this method completes successfully, the given transferListener |
| will be asynchronously notified via an IIncomingFileTransferReceiveDoneEvent |
| (along with other possible events). All implementations are required to |
| issue this event whether successful or failed. Listeners |
| can consult <a href="../../../filetransfer/events/IIncomingFileTransferReceiveDoneEvent.html#getException()"><code>IIncomingFileTransferReceiveDoneEvent.getException()</code></a> to |
| determine whether the transfer operation completed successfully. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a></code> in interface <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteFileID1</code> - reference to the remote target file (e.g. |
| http://www.eclipse.org/index.html) or a reference to a |
| resource that specifies the location of a target file. |
| Implementing providers will determine what protocol schemes |
| are supported (e.g. ftp, http, torrent, file, etc) and the |
| required format of the scheme-specific information. If a |
| protocol is specified that is not supported, or the |
| scheme-specific information is not well-formed, then an |
| IncomingFileTransferException will be thrown. Typically, |
| callers will create IFileID instances via calls such as: |
| |
| <pre> |
| IFileID remoteFileID = FileIDFactory.getDefault().createID( |
| ftc.getRetrieveNamespace(), "http://www.composent.com/index.html"); |
| </pre> |
| |
| Must not be <code>null</code>.</dd> |
| <dd><code>transferListener</code> - a listener for file transfer events. Must not be null. Must not be null. See <b>Note</b> above.</dd> |
| <dd><code>options1</code> - a Map of options associated with sendRetrieveRequest. The |
| particular name/value pairs will be unique to the individual |
| providers. May be <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../filetransfer/IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></code> - if the provider is not connected or is not in the correct |
| state for initiating file transfer</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRetrieveNamespace()">getRetrieveNamespace</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span> <span class="memberName">getRetrieveNamespace</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#getRetrieveNamespace()">IRetrieveFileTransferContainerAdapter</a></code></span></div> |
| <div class="block">Get namespace to be used for creation of remoteFileID for retrieve |
| request. Result typically used as first parameter for |
| <a href="../../../core/identity/IDFactory.html#createID(org.eclipse.ecf.core.identity.Namespace,java.lang.String)"><code>IDFactory.createID(Namespace, String)</code></a> to be used as first in |
| <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#getRetrieveNamespace()">getRetrieveNamespace</a></code> in interface <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Namespace to use for ID creation via |
| <a href="../../../core/identity/IDFactory.html#createID(org.eclipse.ecf.core.identity.Namespace,java.lang.String)"><code>IDFactory.createID(Namespace, String)</code></a>. Will not be |
| <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isPaused()">isPaused</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isPaused</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransferPausable.html#isPaused()">isPaused</a></code> in interface <code><a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferPausable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean true if file transfer paused, false if not paused</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="doPause()">doPause</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected abstract</span> <span class="returnType">boolean</span> <span class="memberName">doPause</span>()</div> |
| <div class="block">Subclass overridable version of <a href="#pause()"><code>pause()</code></a>. Subclasses must provide |
| an implementation of this method to support <a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileTransferPausable</code></a> |
| .</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the pause is successful. <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="pause()">pause</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">pause</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransferPausable.html#pause()">IFileTransferPausable</a></code></span></div> |
| <div class="block">Pause file transfer. Returns true if the associated IFileTransfer is |
| successfully paused. Returns false if the implementing file transfer |
| cannot be paused, or transfer has already completed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransferPausable.html#pause()">pause</a></code> in interface <code><a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferPausable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean true if file transfer successfully paused. False if cannot be |
| paused, or the transfer has already completed</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="doResume()">doResume</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected abstract</span> <span class="returnType">boolean</span> <span class="memberName">doResume</span>()</div> |
| <div class="block">Subclass overridable version of <a href="#resume()"><code>resume()</code></a>. Subclasses must |
| provide an implementation of this method to support |
| <a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileTransferPausable</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the resume is successful. <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="resume()">resume</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">resume</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IFileTransferPausable.html#resume()">IFileTransferPausable</a></code></span></div> |
| <div class="block">Resume file transfer after having been paused. If successfully resumed, |
| then returns true. If the associated IFileShare is not already paused, or |
| has already completed then this method returns false.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IFileTransferPausable.html#resume()">resume</a></code> in interface <code><a href="../../../filetransfer/IFileTransferPausable.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferPausable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean true if transfer is successfully resumed, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getListener()">getListener</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a></span> <span class="memberName">getListener</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IIncomingFileTransfer.html#getListener()">IIncomingFileTransfer</a></code></span></div> |
| <div class="block">Get listener assigned to this incoming file transfer. May be <code>null</code> if no listener |
| has been provided.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IIncomingFileTransfer.html#getListener()">getListener</a></code> in interface <code><a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>listener the IFileTransferListener provided for this incoming file transfer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createRangeName()">createRangeName</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">createRangeName</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createJobName()">createJobName</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">createJobName</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setupAndScheduleJob(org.eclipse.ecf.filetransfer.FileTransferJob)">setupAndScheduleJob</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setupAndScheduleJob</span>​(<span class="arguments"><a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> fileTransferJob)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireReceiveStartEvent()">fireReceiveStartEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireReceiveStartEvent</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireReceiveResumedEvent()">fireReceiveResumedEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireReceiveResumedEvent</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFileRangeSpecification()">getFileRangeSpecification</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a></span> <span class="memberName">getFileRangeSpecification</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IIncomingFileTransfer.html#getFileRangeSpecification()">IIncomingFileTransfer</a></code></span></div> |
| <div class="block">Get file range specification for this incoming file transfer instance. Will return |
| <code>null</code> if the retrieval is of the entire file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IIncomingFileTransfer.html#getFileRangeSpecification()">getFileRangeSpecification</a></code> in interface <code><a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>file range specification for this incoming file transfer instance. Returns |
| <code>null</code> if the retrieval is of the entire file.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">sendRetrieveRequest</span>​(<span class="arguments"><a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> rFileID, |
| <a href="../../../filetransfer/IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer">IFileRangeSpecification</a> rangeSpec, |
| <a href="../../../filetransfer/IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a> transferListener, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a> ops)</span> |
| throws <span class="exceptions"><a href="../../../filetransfer/IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">IRetrieveFileTransferContainerAdapter</a></code></span></div> |
| <div class="block">Send request for transfer of a remote file to local file storage. This |
| method is used to initiate a file retrieve for a remoteFileID (first |
| parameter). File transfer events are asynchronously delivered a file |
| transfer listener (third parameter). The given remoteFileID and |
| transferListener must not be null. |
| <p> |
| <b>NOTE</b>: if this method completes successfully, the given transferListener |
| will be asynchronously notified via an IIncomingFileTransferReceiveDoneEvent |
| (along with other possible events). All implementations are required to |
| issue this event whether successful or failed. Listeners |
| can consult <a href="../../../filetransfer/events/IIncomingFileTransferReceiveDoneEvent.html#getException()"><code>IIncomingFileTransferReceiveDoneEvent.getException()</code></a> to |
| determine whether the transfer operation completed successfully. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a></code> in interface <code><a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">IRetrieveFileTransferContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rFileID</code> - reference to the remote target file (e.g. |
| http://www.eclipse.org/index.html) or a reference to a |
| resource that specifies the location of a target file. |
| Implementing providers will determine what protocol schemes |
| are supported (e.g. ftp, http, torrent, file, etc) and the |
| required format of the scheme-specific information. If a |
| protocol is specified that is not supported, or the |
| scheme-specific information is not well-formed, then an |
| IncomingFileTransferException will be thrown. Typically, |
| callers will create IFileID instances via calls such as: |
| |
| <pre> |
| IFileID remoteFileID = FileIDFactory.getDefault().createID( |
| ftc.getRetrieveNamespace(), "http://www.composent.com/index.html"); |
| </pre> |
| |
| Must not be <code>null</code>.</dd> |
| <dd><code>rangeSpec</code> - a range specification for retrieving a portion of the given |
| remote file. If <code>null</code> the entire file will be retrieved (as per <a href="../../../filetransfer/IRetrieveFileTransferContainerAdapter.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a>. |
| If non-<code>null</code> the given file range will be used to retrieve the given file. For example, if the |
| rangeSpecification has a start value of 1 and end value of 3, and the total length of the file is |
| 5 bytes with content [a, b, c, d, e], a successful retrieve request would transfer bytes 'b', 'c', and 'd', but not 'a', and 'e'.</dd> |
| <dd><code>transferListener</code> - a listener for file transfer events. Must not be null. See <b>Note</b> above.</dd> |
| <dd><code>ops</code> - a Map of options associated with sendRetrieveRequest. The |
| particular name/value pairs will be unique to the individual |
| providers. May be <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../filetransfer/IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></code> - if some problem sending retrieve request</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected abstract</span> <span class="returnType">void</span> <span class="memberName">setupProxy</span>​(<span class="arguments"><a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</span></div> |
| <div class="block">Setup ECF proxy. Subclasses must override this method to do appropriate |
| proxy setup. This method will be called from within |
| <a href="#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a> and |
| <a href="#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>sendRetrieveRequest(IFileID, IFileRangeSpecification, IFileTransferListener, Map)</code></a> |
| , prior to the actual call to <a href="#openStreams()"><code>openStreams()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>proxy</code> - the proxy to be setup. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData[])">selectProxyFromProxies</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.eclipse.core.net.proxy.IProxyData</span> <span class="memberName">selectProxyFromProxies</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> protocol, |
| org.eclipse.core.net.proxy.IProxyData[] proxies)</span></div> |
| <div class="block">Select a single proxy from a set of proxies available for the given host. |
| This implementation selects in the following manner: 1) If proxies |
| provided is null or array of 0 length, null is returned. If only one |
| proxy is available (array of length 1) then the entry is returned. If |
| proxies provided is length greater than 1, then if the type of a proxy in the array |
| matches the given protocol (e.g. http, https), then the first matching |
| proxy is returned. If the protocol does not match any of the proxies, |
| then the *first* proxy (i.e. proxies[0]) is returned. Subclasses may |
| override if desired.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocol</code> - the target protocol (e.g. http, https, scp, etc). Will not be |
| <code>null</code>.</dd> |
| <dd><code>proxies</code> - the proxies to select from. May be <code>null</code> or array |
| of length 0.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>proxy data selected from the proxies provided.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setupProxies()">setupProxies</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setupProxies</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteFileName()">getRemoteFileName</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getRemoteFileName</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../filetransfer/IIncomingFileTransfer.html#getRemoteFileName()">IIncomingFileTransfer</a></code></span></div> |
| <div class="block">Obtains the name of the remote file if possible. The name will typically but not |
| necessarily be the same as the leaf part of the path to the remote file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../filetransfer/IIncomingFileTransfer.html#getRemoteFileName()">getRemoteFileName</a></code> in interface <code><a href="../../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The name of the remote file or <code>null</code> if no such name can be determined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="targetHasGzSuffix(java.lang.String)">targetHasGzSuffix</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">targetHasGzSuffix</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> target)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractRetrieveFileTransfer.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> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
