| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>HttpClientRetrieveFileTransfer (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.httpclient45, class: HttpClientRetrieveFileTransfer"> |
| <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":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":9,"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":10,"i33":10,"i34":9,"i35":9,"i36":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/HttpClientRetrieveFileTransfer.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.httpclient45</a></div> |
| <h1 title="Class HttpClientRetrieveFileTransfer" class="title">Class HttpClientRetrieveFileTransfer</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"><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer</a> |
| <div class="inheritance">org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientRetrieveFileTransfer</div> |
| </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> |
| <hr> |
| <pre>public class <span class="typeNameLabel">HttpClientRetrieveFileTransfer</span> |
| extends <a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</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 <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="#fileid">fileid</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected 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="#HTTP">HTTP</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="#HTTP_PORT">HTTP_PORT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected 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="#HTTPS">HTTPS</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="#HTTPS_PORT">HTTPS_PORT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpVersion">httpVersion</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="#MAX_RETRY">MAX_RETRY</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../util/JREProxyHelper.html" title="class in org.eclipse.ecf.provider.filetransfer.util">JREProxyHelper</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proxyHelper">proxyHelper</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected 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="#supportedProtocols">supportedProtocols</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h3>Fields inherited from class org.eclipse.ecf.provider.filetransfer.retrieve.<a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></h3> |
| <a id="fields.inherited.from.class.org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer"> |
| <!-- --> |
| </a><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#buff_length">buff_length</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#bytesReceived">bytesReceived</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#CLOSE_TIMEOUT">CLOSE_TIMEOUT</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#closeOutputStream">closeOutputStream</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#connectContext">connectContext</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#DEFAULT_BUF_LENGTH">DEFAULT_BUF_LENGTH</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#done">done</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#downloadRateBytesPerSecond">downloadRateBytesPerSecond</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#exception">exception</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#fileLength">fileLength</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#job">job</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#jobLock">jobLock</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#lastModifiedTime">lastModifiedTime</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#listener">listener</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#localFileContents">localFileContents</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#options">options</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#paused">paused</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#POLLING_RETRY_ATTEMPTS">POLLING_RETRY_ATTEMPTS</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#proxy">proxy</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#rangeSpecification">rangeSpecification</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#READ_TIMEOUT">READ_TIMEOUT</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#remoteFileContents">remoteFileContents</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#remoteFileID">remoteFileID</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#remoteFileURL">remoteFileURL</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#responseHeaders">responseHeaders</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#TIMEOUT_INPUTSTREAM_BUFFER_SIZE">TIMEOUT_INPUTSTREAM_BUFFER_SIZE</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#transferStartTime">transferStartTime</a></code></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(org.apache.http.impl.client.CloseableHttpClient)">HttpClientRetrieveFileTransfer</a></span>​(org.apache.http.impl.client.CloseableHttpClient client)</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="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 void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearProxy()">clearProxy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This method will clear out the proxy information (so that if this is |
| reused for a request without a proxy, it will work correctly).</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectUsingJob(org.eclipse.ecf.filetransfer.FileTransferJob)">connectUsingJob</a></span>​(<a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> cjob)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <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="#createConnectJobName()">createConnectJobName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>protected 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="../retrieve/AbstractRetrieveFileTransfer.html#pause()"><code>AbstractRetrieveFileTransfer.pause()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>protected 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="../retrieve/AbstractRetrieveFileTransfer.html#resume()"><code>AbstractRetrieveFileTransfer.resume()</code></a>.</div> |
| </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="#fireConnectStartEvent()">fireConnectStartEvent</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="#fireReceiveResumedEvent()">fireReceiveResumedEvent</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="#fireTransferReceiveDataEvent()">fireTransferReceiveDataEvent</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="#fireTransferReceiveDoneEvent()">fireTransferReceiveDoneEvent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <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="rowColor" id="i11"> |
| <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="altColor" id="i12"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectTimeout()">getConnectTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>protected org.apache.http.auth.Credentials</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileRequestCredentials()">getFileRequestCredentials</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>protected 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="#getHostFromURL(java.lang.String)">getHostFromURL</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> url)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <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="altColor" id="i16"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPortFromURL(java.lang.String)">getPortFromURL</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> url)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <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="altColor" id="i18"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseCode()">getResponseCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseHeaderValues()">getResponseHeaderValues</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResumeResponseHeaderValues()">getResumeResponseHeaderValues</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <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="i22"> |
| <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="rowColor" id="i23"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConnected()">isConnected</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code>protected 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="i25"> |
| <td class="colFirst"><code>protected <a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareConnectJob(org.eclipse.ecf.filetransfer.FileTransferJob)">prepareConnectJob</a></span>​(<a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> cjob)</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="#resetDoneAndException()">resetDoneAndException</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <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="altColor" id="i28"> |
| <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="i29"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequestHeaderValues()">setRequestHeaderValues</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResumeRequestHeaderValues()">setResumeRequestHeaderValues</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupAuthentication(java.lang.String)">setupAuthentication</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> urlString)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <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="rowColor" id="i33"> |
| <td class="colFirst"><code>protected 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="altColor" id="i34"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportsProtocol(java.lang.String)">supportsProtocol</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> protocolString)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code>protected static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#urlUsesHttps(java.lang.String)">urlUsesHttps</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> url)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <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 org.eclipse.ecf.provider.filetransfer.retrieve.<a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer"> |
| <!-- --> |
| </a><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#createJobName()">createJobName</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#createRangeName()">createRangeName</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#fireReceiveStartEvent()">fireReceiveStartEvent</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getBytesReceived()">getBytesReceived</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getException()">getException</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getFileLength()">getFileLength</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getFileRangeSpecification()">getFileRangeSpecification</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getFinalStatus(java.lang.Throwable)">getFinalStatus</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getListener()">getListener</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getOptions()">getOptions</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getPercentComplete()">getPercentComplete</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getRemoteFileURL()">getRemoteFileURL</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getRemoteLastModified()">getRemoteLastModified</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getRetrieveNamespace()">getRetrieveNamespace</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#getSocketCloseTimeout()">getSocketCloseTimeout</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#handleReceivedData(byte%5B%5D,int,double,org.eclipse.core.runtime.IProgressMonitor)">handleReceivedData</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#isCanceled()">isCanceled</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#isDone()">isDone</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#isPaused()">isPaused</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#newUserCancelledException()">newUserCancelledException</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#pause()">pause</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#resume()">resume</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData%5B%5D)">selectProxyFromProxies</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendRetrieveRequest</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setCloseOutputStream(boolean)">setCloseOutputStream</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setDone(boolean)">setDone</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setDoneCanceled()">setDoneCanceled</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setDoneCanceled(java.lang.Exception)">setDoneCanceled</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setDoneException(java.lang.Exception)">setDoneException</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setFileLength(long)">setFileLength</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setLastModifiedTime(long)">setLastModifiedTime</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setOutputStream(java.io.OutputStream)">setOutputStream</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#setupAndScheduleJob(org.eclipse.ecf.filetransfer.FileTransferJob)">setupAndScheduleJob</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#targetHasGzSuffix(java.lang.String)">targetHasGzSuffix</a>, <a href="../retrieve/AbstractRetrieveFileTransfer.html#toHumanReadableBytes(double)">toHumanReadableBytes</a></code></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="HTTP_PORT">HTTP_PORT</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">HTTP_PORT</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientRetrieveFileTransfer.HTTP_PORT">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="HTTPS_PORT">HTTPS_PORT</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">HTTPS_PORT</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientRetrieveFileTransfer.HTTPS_PORT">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="MAX_RETRY">MAX_RETRY</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">MAX_RETRY</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientRetrieveFileTransfer.MAX_RETRY">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="HTTPS">HTTPS</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</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">HTTPS</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientRetrieveFileTransfer.HTTPS">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="HTTP">HTTP</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</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">HTTP</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientRetrieveFileTransfer.HTTP">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="supportedProtocols">supportedProtocols</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</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">supportedProtocols</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="httpVersion">httpVersion</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">int</span> <span class="memberName">httpVersion</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fileid">fileid</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">fileid</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="proxyHelper">proxyHelper</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../util/JREProxyHelper.html" title="class in org.eclipse.ecf.provider.filetransfer.util">JREProxyHelper</a></span> <span class="memberName">proxyHelper</span></div> |
| </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>(org.apache.http.impl.client.CloseableHttpClient)">HttpClientRetrieveFileTransfer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">HttpClientRetrieveFileTransfer</span>​(<span class="arguments">org.apache.http.impl.client.CloseableHttpClient client)</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="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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#getRemoteFileName()">getRemoteFileName</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</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="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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#cancel()">cancel</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#hardClose()">hardClose</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFileRequestCredentials()">getFileRequestCredentials</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.apache.http.auth.Credentials</span> <span class="memberName">getFileRequestCredentials</span>() |
| throws <span class="exceptions"><a href="../../../core/security/UnsupportedCallbackException.html" title="class in org.eclipse.ecf.core.security">UnsupportedCallbackException</a>, |
| <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="returnLabel">Returns:</span></dt> |
| <dd>Credentials file request credentials</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../core/security/UnsupportedCallbackException.html" title="class in org.eclipse.ecf.core.security">UnsupportedCallbackException</a></code> - if some problem</dd> |
| <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> - if some problem</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#setupProxies()">setupProxies</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#resetDoneAndException()">resetDoneAndException</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setupAuthentication(java.lang.String)">setupAuthentication</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setupAuthentication</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> urlString)</span> |
| throws <span class="exceptions"><a href="../../../core/security/UnsupportedCallbackException.html" title="class in org.eclipse.ecf.core.security">UnsupportedCallbackException</a>, |
| <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="../../../core/security/UnsupportedCallbackException.html" title="class in org.eclipse.ecf.core.security">UnsupportedCallbackException</a></code></dd> |
| <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="setRequestHeaderValues()">setRequestHeaderValues</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setRequestHeaderValues</span>() |
| throws <span class="exceptions"><a href="../../../filetransfer/InvalidFileRangeSpecificationException.html" title="class in org.eclipse.ecf.filetransfer">InvalidFileRangeSpecificationException</a></span></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../filetransfer/InvalidFileRangeSpecificationException.html" title="class in org.eclipse.ecf.filetransfer">InvalidFileRangeSpecificationException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getResponseCode()">getResponseCode</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getResponseCode</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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#getID()">getID</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</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="getResponseHeaderValues()">getResponseHeaderValues</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">getResponseHeaderValues</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="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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#setInputStream(java.io.InputStream)">setInputStream</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#wrapTransferReadInputStream(java.io.InputStream,org.eclipse.core.runtime.IProgressMonitor)">wrapTransferReadInputStream</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#getSocketReadTimeout()">getSocketReadTimeout</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getConnectTimeout()">getConnectTimeout</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">int</span> <span class="memberName">getConnectTimeout</span>()</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int connect timeout</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="openStreams()">openStreams</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../retrieve/AbstractRetrieveFileTransfer.html#openStreams()">AbstractRetrieveFileTransfer</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#openStreams()">openStreams</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></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</dd> |
| </dl> |
| </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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</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="getHostFromURL(java.lang.String)">getHostFromURL</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected 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">getHostFromURL</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> url)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getPortFromURL(java.lang.String)">getPortFromURL</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType">int</span> <span class="memberName">getPortFromURL</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> url)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="urlUsesHttps(java.lang.String)">urlUsesHttps</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType">boolean</span> <span class="memberName">urlUsesHttps</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> url)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="supportsProtocol(java.lang.String)">supportsProtocol</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">supportsProtocol</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> protocolString)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isConnected()">isConnected</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">isConnected</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="doPause()">doPause</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">doPause</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../retrieve/AbstractRetrieveFileTransfer.html#doPause()">AbstractRetrieveFileTransfer</a></code></span></div> |
| <div class="block">Subclass overridable version of <a href="../retrieve/AbstractRetrieveFileTransfer.html#pause()"><code>AbstractRetrieveFileTransfer.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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#doPause()">doPause</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| <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="doResume()">doResume</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">doResume</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../retrieve/AbstractRetrieveFileTransfer.html#doResume()">AbstractRetrieveFileTransfer</a></code></span></div> |
| <div class="block">Subclass overridable version of <a href="../retrieve/AbstractRetrieveFileTransfer.html#resume()"><code>AbstractRetrieveFileTransfer.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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#doResume()">doResume</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| <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="setResumeRequestHeaderValues()">setResumeRequestHeaderValues</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">setResumeRequestHeaderValues</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>, |
| <a href="../../../filetransfer/InvalidFileRangeSpecificationException.html" title="class in org.eclipse.ecf.filetransfer">InvalidFileRangeSpecificationException</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> |
| <dd><code><a href="../../../filetransfer/InvalidFileRangeSpecificationException.html" title="class in org.eclipse.ecf.filetransfer">InvalidFileRangeSpecificationException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getResumeResponseHeaderValues()">getResumeResponseHeaderValues</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">getResumeResponseHeaderValues</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="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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#getAdapter(java.lang.Class)">getAdapter</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></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</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../retrieve/AbstractRetrieveFileTransfer.html#setupProxy(org.eclipse.ecf.core.util.Proxy)">AbstractRetrieveFileTransfer</a></code></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="../retrieve/AbstractRetrieveFileTransfer.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>AbstractRetrieveFileTransfer.sendRetrieveRequest(IFileID, IFileTransferListener, Map)</code></a> and |
| <a href="../retrieve/AbstractRetrieveFileTransfer.html#sendRetrieveRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileRangeSpecification,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)"><code>AbstractRetrieveFileTransfer.sendRetrieveRequest(IFileID, IFileRangeSpecification, IFileTransferListener, Map)</code></a> |
| , prior to the actual call to <a href="../retrieve/AbstractRetrieveFileTransfer.html#openStreams()"><code>AbstractRetrieveFileTransfer.openStreams()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| <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="clearProxy()">clearProxy</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">clearProxy</span>()</div> |
| <div class="block">This method will clear out the proxy information (so that if this is |
| reused for a request without a proxy, it will work correctly).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireConnectStartEvent()">fireConnectStartEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireConnectStartEvent</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createConnectJobName()">createConnectJobName</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">createConnectJobName</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareConnectJob(org.eclipse.ecf.filetransfer.FileTransferJob)">prepareConnectJob</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a></span> <span class="memberName">prepareConnectJob</span>​(<span class="arguments"><a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> cjob)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connectUsingJob(org.eclipse.ecf.filetransfer.FileTransferJob)">connectUsingJob</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">connectUsingJob</span>​(<span class="arguments"><a href="../../../filetransfer/FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> cjob)</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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#fireReceiveResumedEvent()">fireReceiveResumedEvent</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#fireTransferReceiveDataEvent()">fireTransferReceiveDataEvent</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#fireTransferReceiveDoneEvent()">fireTransferReceiveDoneEvent</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../retrieve/AbstractRetrieveFileTransfer.html#fireTransferReceivePausedEvent()">fireTransferReceivePausedEvent</a></code> in class <code><a href="../retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code></dd> |
| </dl> |
| </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/HttpClientRetrieveFileTransfer.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> |
