| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>IFileTransferRequestEvent (Eclipse Communication Framework (ECF) 3.14.22 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <meta name="dc.created" content="2021-06-15"> |
| <meta name="description" content="declaration: package: org.eclipse.ecf.filetransfer.events, interface: IFileTransferRequestEvent"> |
| <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":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IFileTransferRequestEvent.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.filetransfer.events</a></div> |
| <h1 title="Interface IFileTransferRequestEvent" class="title">Interface IFileTransferRequestEvent</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../../core/util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a></code>, <code><a href="IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events">IFileTransferEvent</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IFileTransferRequestEvent</span> |
| extends <a href="IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events">IFileTransferEvent</a></pre> |
| <div class="block">Event to represent remote file transfer requests. Events implementing this |
| interface are delivered to <a href="../IIncomingFileTransferRequestListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IIncomingFileTransferRequestListener</code></a></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../IIncomingFileTransferRequestListener.html#handleFileTransferRequest(org.eclipse.ecf.filetransfer.events.IFileTransferRequestEvent)"><code>IIncomingFileTransferRequestListener.handleFileTransferRequest(IFileTransferRequestEvent)</code></a></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== 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="t3" class="tableTab" onclick="show(4);">Abstract 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><a href="../IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(java.io.File)">accept</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> localFileToSave)</code></th> |
| <td class="colLast"> |
| <div class="block">Accept the file transfer request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="../IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(java.io.OutputStream,org.eclipse.ecf.filetransfer.IFileTransferListener)">accept</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> outputStream, |
| <a href="../IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Accept the file transfer request.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="../IFileTransferInfo.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileTransferInfo()">getFileTransferInfo</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get file transfer info associated with this file transfer request even</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <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="#getRequesterID()">getRequesterID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get ID of remote requester</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reject()">reject</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reject the file transfer request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestAccepted()">requestAccepted</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If request was accepted from remote target (via successful call to |
| <a href="#accept(java.io.File)"><code>accept(File)</code></a>this method will return true, if rejected or failed |
| returns false.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ 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="getRequesterID()">getRequesterID</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">getRequesterID</span>()</div> |
| <div class="block">Get ID of remote requester</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of remote requester. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFileTransferInfo()">getFileTransferInfo</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../IFileTransferInfo.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferInfo</a></span> <span class="memberName">getFileTransferInfo</span>()</div> |
| <div class="block">Get file transfer info associated with this file transfer request even</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFileTransfer info. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="accept(java.io.File)">accept</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></span> <span class="memberName">accept</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> localFileToSave)</span> |
| throws <span class="exceptions"><a href="../IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></span></div> |
| <div class="block">Accept the file transfer request. This method should be called if the |
| receiver of the IFileTransferRequestEvent would like to accept the file |
| transfer request. Will not return <code>null</code>. Once called |
| successfully, then <a href="#requestAccepted()"><code>requestAccepted()</code></a> will return true, and |
| further calls to <a href="#accept(java.io.File)"><code>accept(File)</code></a> or |
| <a href="#accept(java.io.OutputStream,org.eclipse.ecf.filetransfer.IFileTransferListener)"><code>accept(OutputStream, IFileTransferListener)</code></a> will throw |
| IncomingFileTransferExceptions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localFileToSave</code> - the file on the local file system to receive the remote file. |
| Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IIncomingFileTransfer to receive file. Will not be |
| <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></code> - if accept message cannot be delivered back to requester</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="accept(java.io.OutputStream,org.eclipse.ecf.filetransfer.IFileTransferListener)">accept</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></span> <span class="memberName">accept</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> outputStream, |
| <a href="../IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransferListener</a> listener)</span> |
| throws <span class="exceptions"><a href="../IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></span></div> |
| <div class="block">Accept the file transfer request. This method should be called if the |
| receiver of the IFileTransferRequestEvent would like to accept the file |
| transfer request. Will not return <code>null</code>. Once called |
| successfully, then <a href="#requestAccepted()"><code>requestAccepted()</code></a> will return true, and |
| further calls to <a href="#accept(java.io.File)"><code>accept(File)</code></a> or |
| <a href="#accept(java.io.OutputStream,org.eclipse.ecf.filetransfer.IFileTransferListener)"><code>accept(OutputStream, IFileTransferListener)</code></a> will throw |
| IncomingFileTransferExceptions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>outputStream</code> - the output stream to receive the accepted file contents. Must |
| not be <code>null</code>.</dd> |
| <dd><code>listener</code> - for file transfer events during file reception. May be |
| <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IIncomingFileTransfer to receive file. Will not be |
| <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../IncomingFileTransferException.html" title="class in org.eclipse.ecf.filetransfer">IncomingFileTransferException</a></code> - if accept message cannot be delivered back to requester</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="reject()">reject</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">reject</span>()</div> |
| <div class="block">Reject the file transfer request. This method should be called if the |
| receiver of the IFileTransferRequestEvent would like to reject the file |
| transfer request</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="requestAccepted()">requestAccepted</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">requestAccepted</span>()</div> |
| <div class="block">If request was accepted from remote target (via successful call to |
| <a href="#accept(java.io.File)"><code>accept(File)</code></a>this method will return true, if rejected or failed |
| returns false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if request was accepted, false if rejected or failed</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/IFileTransferRequestEvent.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
