| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>IRemoteFileSystemBrowserContainerAdapter (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, interface: IRemoteFileSystemBrowserContainerAdapter"> |
| <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}; |
| 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/IRemoteFileSystemBrowserContainerAdapter.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</a></div> |
| <h1 title="Interface IRemoteFileSystemBrowserContainerAdapter" class="title">Interface IRemoteFileSystemBrowserContainerAdapter</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>org.eclipse.core.runtime.IAdaptable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="service/IRemoteFileSystemBrowser.html" title="interface in org.eclipse.ecf.filetransfer.service">IRemoteFileSystemBrowser</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../provider/filetransfer/browse/MultiProtocolFileSystemBrowserAdapter.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">MultiProtocolFileSystemBrowserAdapter</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IRemoteFileSystemBrowserContainerAdapter</span> |
| extends org.eclipse.core.runtime.IAdaptable</pre> |
| <div class="block">Remote file system browser adapter. This adapter can be retrieved from a container |
| for exposing remote file system browsing capabilities.</div> |
| </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="../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBrowseNamespace()">getBrowseNamespace</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the <a href="../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity"><code>Namespace</code></a> instance for creating IFileIDs that represent remote files or directories.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)">sendBrowseRequest</a></span>​(<a href="identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> directoryOrFileID, |
| <a href="IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Send a request for file or directory information for given directoryOrFileID.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <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="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a></span>​(<a href="../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</code></th> |
| <td class="colLast"> |
| <div class="block">Set proxy for use upon subsequent |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.core.runtime.IAdaptable</h3> |
| <a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable"> |
| <!-- --> |
| </a><code>getAdapter</code></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="getBrowseNamespace()">getBrowseNamespace</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span> <span class="memberName">getBrowseNamespace</span>()</div> |
| <div class="block">Get the <a href="../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity"><code>Namespace</code></a> instance for creating IFileIDs that represent remote files or directories.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Namespace for remote files or directories. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)">sendBrowseRequest</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></span> <span class="memberName">sendBrowseRequest</span>​(<span class="arguments"><a href="identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> directoryOrFileID, |
| <a href="IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a> listener)</span> |
| throws <span class="exceptions"><a href="RemoteFileSystemException.html" title="class in org.eclipse.ecf.filetransfer">RemoteFileSystemException</a></span></div> |
| <div class="block">Send a request for file or directory information for given directoryOrFileID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>directoryOrFileID</code> - the IFileID representing/specifying the remote directory or file to access.</dd> |
| <dd><code>listener</code> - the listener that will be notified asynchronously when a response to this request is received. Must not be |
| <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteFileSystemRequest the request instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="RemoteFileSystemException.html" title="class in org.eclipse.ecf.filetransfer">RemoteFileSystemException</a></code> - if browse request cannot be accomplished</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="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">Set connect context for authentication upon subsequent |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>. This |
| method should be called with a non-null connectContext in order to allow |
| authentication to occur during call to |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectContext</code> - the connect context to use for authenticating during |
| subsequent call to |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>. |
| If <code>null</code>, then no authentication will be |
| attempted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setProxy(org.eclipse.ecf.core.util.Proxy)">setProxy</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">setProxy</span>​(<span class="arguments"><a href="../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</span></div> |
| <div class="block">Set proxy for use upon subsequent |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>. This |
| method should be called with a non-null proxy to allow the given proxy to |
| be used in subsequent calls to |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>proxy</code> - the proxy to use for subsequent calls to |
| <a href="#sendBrowseRequest(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener)"><code>sendBrowseRequest(IFileID, IRemoteFileSystemListener)</code></a>. |
| If <code>null</code>, then no proxy will be used.</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/IRemoteFileSystemBrowserContainerAdapter.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> |
