blob: e33a8c4ba742e507bd5b360ad36e56c6817e7eea [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
<title>LocalFileOutgoingFileTransfer (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.outgoing, class: LocalFileOutgoingFileTransfer">
<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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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/LocalFileOutgoingFileTransfer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.ecf.provider.filetransfer.outgoing</a></div>
<h1 title="Class LocalFileOutgoingFileTransfer" class="title">Class LocalFileOutgoingFileTransfer</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="AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">org.eclipse.ecf.provider.filetransfer.outgoing.AbstractOutgoingFileTransfer</a>
<div class="inheritance">org.eclipse.ecf.provider.filetransfer.outgoing.LocalFileOutgoingFileTransfer</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/IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IOutgoingFileTransfer</a></code>, <code><a href="../../../filetransfer/ISendFileTransferContainerAdapter.html" title="interface in org.eclipse.ecf.filetransfer">ISendFileTransferContainerAdapter</a></code>, <code><a href="../../../filetransfer/service/ISendFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer.service">ISendFileTransfer</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">LocalFileOutgoingFileTransfer</span>
extends <a href="AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</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="inheritedList">
<h3>Fields inherited from class&nbsp;org.eclipse.ecf.provider.filetransfer.outgoing.<a href="AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></h3>
<a id="fields.inherited.from.class.org.eclipse.ecf.provider.filetransfer.outgoing.AbstractOutgoingFileTransfer">
<!-- -->
</a><code><a href="AbstractOutgoingFileTransfer.html#buff_length">buff_length</a>, <a href="AbstractOutgoingFileTransfer.html#bytesSent">bytesSent</a>, <a href="AbstractOutgoingFileTransfer.html#connectContext">connectContext</a>, <a href="AbstractOutgoingFileTransfer.html#DEFAULT_BUF_LENGTH">DEFAULT_BUF_LENGTH</a>, <a href="AbstractOutgoingFileTransfer.html#done">done</a>, <a href="AbstractOutgoingFileTransfer.html#exception">exception</a>, <a href="AbstractOutgoingFileTransfer.html#fileTransferInfo">fileTransferInfo</a>, <a href="AbstractOutgoingFileTransfer.html#job">job</a>, <a href="AbstractOutgoingFileTransfer.html#listener">listener</a>, <a href="AbstractOutgoingFileTransfer.html#localFileContents">localFileContents</a>, <a href="AbstractOutgoingFileTransfer.html#options">options</a>, <a href="AbstractOutgoingFileTransfer.html#proxy">proxy</a>, <a href="AbstractOutgoingFileTransfer.html#remoteFileContents">remoteFileContents</a>, <a href="AbstractOutgoingFileTransfer.html#remoteFileID">remoteFileID</a>, <a href="AbstractOutgoingFileTransfer.html#remoteFileURL">remoteFileURL</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">&nbsp;</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()">LocalFileOutgoingFileTransfer</a></span>()</code></th>
<td class="colLast">&nbsp;</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="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>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="i1">
<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>&#8203;(<a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a>&nbsp;proxy)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;org.eclipse.ecf.provider.filetransfer.outgoing.<a href="AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.provider.filetransfer.outgoing.AbstractOutgoingFileTransfer">
<!-- -->
</a><code><a href="AbstractOutgoingFileTransfer.html#addListener(org.eclipse.ecf.filetransfer.IIncomingFileTransferRequestListener)">addListener</a>, <a href="AbstractOutgoingFileTransfer.html#cancel()">cancel</a>, <a href="AbstractOutgoingFileTransfer.html#createJobName()">createJobName</a>, <a href="AbstractOutgoingFileTransfer.html#fireSendStartEvent()">fireSendStartEvent</a>, <a href="AbstractOutgoingFileTransfer.html#fireTransferSendDataEvent()">fireTransferSendDataEvent</a>, <a href="AbstractOutgoingFileTransfer.html#fireTransferSendDoneEvent()">fireTransferSendDoneEvent</a>, <a href="AbstractOutgoingFileTransfer.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="AbstractOutgoingFileTransfer.html#getBytesSent()">getBytesSent</a>, <a href="AbstractOutgoingFileTransfer.html#getException()">getException</a>, <a href="AbstractOutgoingFileTransfer.html#getFileLength()">getFileLength</a>, <a href="AbstractOutgoingFileTransfer.html#getFileTransferInfo()">getFileTransferInfo</a>, <a href="AbstractOutgoingFileTransfer.html#getFinalStatus(java.lang.Throwable)">getFinalStatus</a>, <a href="AbstractOutgoingFileTransfer.html#getID()">getID</a>, <a href="AbstractOutgoingFileTransfer.html#getListener()">getListener</a>, <a href="AbstractOutgoingFileTransfer.html#getOptions()">getOptions</a>, <a href="AbstractOutgoingFileTransfer.html#getOutgoingNamespace()">getOutgoingNamespace</a>, <a href="AbstractOutgoingFileTransfer.html#getPercentComplete()">getPercentComplete</a>, <a href="AbstractOutgoingFileTransfer.html#getRemoteFileURL()">getRemoteFileURL</a>, <a href="AbstractOutgoingFileTransfer.html#hardClose()">hardClose</a>, <a href="AbstractOutgoingFileTransfer.html#isDone()">isDone</a>, <a href="AbstractOutgoingFileTransfer.html#removeListener(org.eclipse.ecf.filetransfer.IIncomingFileTransferRequestListener)">removeListener</a>, <a href="AbstractOutgoingFileTransfer.html#selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData%5B%5D)">selectProxyFromProxies</a>, <a href="AbstractOutgoingFileTransfer.html#sendOutgoingRequest(org.eclipse.ecf.filetransfer.identity.IFileID,java.io.File,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendOutgoingRequest</a>, <a href="AbstractOutgoingFileTransfer.html#sendOutgoingRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IFileTransferInfo,org.eclipse.ecf.filetransfer.IFileTransferListener,java.util.Map)">sendOutgoingRequest</a>, <a href="AbstractOutgoingFileTransfer.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a>, <a href="AbstractOutgoingFileTransfer.html#setInputStream(java.io.InputStream)">setInputStream</a>, <a href="AbstractOutgoingFileTransfer.html#setOutputStream(java.io.OutputStream)">setOutputStream</a>, <a href="AbstractOutgoingFileTransfer.html#setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a>, <a href="AbstractOutgoingFileTransfer.html#setupAndScheduleJob()">setupAndScheduleJob</a>, <a href="AbstractOutgoingFileTransfer.html#setupProxies()">setupProxies</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;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">
<!-- ========= 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="&lt;init&gt;()">LocalFileOutgoingFileTransfer</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">LocalFileOutgoingFileTransfer</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="openStreams()">openStreams</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">openStreams</span>()
throws <span class="exceptions"><a href="../../../filetransfer/SendFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">SendFileTransferException</a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="AbstractOutgoingFileTransfer.html#openStreams()">AbstractOutgoingFileTransfer</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="AbstractOutgoingFileTransfer.html#openStreams()">openStreams</a></code>&nbsp;in class&nbsp;<code><a href="AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../filetransfer/SendFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">SendFileTransferException</a></code> - if some problem</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>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setupProxy</span>&#8203;(<span class="arguments"><a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a>&nbsp;proxy)</span></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractOutgoingFileTransfer.html#setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></code>&nbsp;in class&nbsp;<code><a href="AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</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/LocalFileOutgoingFileTransfer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>