blob: f0373162c9f04328f0db8b154b1c9ee37e68f2a2 [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>AbstractFileSystemBrowser (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.browse, class: AbstractFileSystemBrowser">
<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":6,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractFileSystemBrowser.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><a href="#nested.class.summary">Nested</a>&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><a href="#field.detail">Field</a>&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.browse</a></div>
<h1 title="Class AbstractFileSystemBrowser" class="title">Class AbstractFileSystemBrowser</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a>
<div class="inheritance">org.eclipse.ecf.provider.filetransfer.browse.AbstractFileSystemBrowser</div>
</div>
<section class="description">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../httpclient4/HttpClientFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient4">HttpClientFileSystemBrowser</a></code>, <code><a href="../httpclient45/HttpClientFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient45">HttpClientFileSystemBrowser</a></code>, <code><a href="../httpclient5/HttpClientFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient5">HttpClientFileSystemBrowser</a></code>, <code><a href="LocalFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">LocalFileSystemBrowser</a></code>, <code><a href="URLFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">URLFileSystemBrowser</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractFileSystemBrowser</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">Abstract class for browsing an efs file system.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li class="blockList">
<section class="nestedClassSummary"><a id="nested.class.summary">
<!-- -->
</a>
<h2>Nested Class Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractFileSystemBrowser.DirectoryJob.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser.DirectoryJob</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractFileSystemBrowser.RemoteFileSystemRequest.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser.RemoteFileSystemRequest</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- =========== 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">&nbsp;</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="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectContext">connectContext</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#directoryOrFile">directoryOrFile</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fileID">fileID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="AbstractFileSystemBrowser.DirectoryJob.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser.DirectoryJob</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#job">job</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../filetransfer/IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listener">listener</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proxy">proxy</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../filetransfer/IRemoteFile.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFile</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteFiles">remoteFiles</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&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(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener,java.net.URL,org.eclipse.ecf.core.security.IConnectContext,org.eclipse.ecf.core.util.Proxy)">AbstractFileSystemBrowser</a></span>&#8203;(<a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a>&nbsp;directoryOrFileID,
<a href="../../../filetransfer/IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a>&nbsp;listener,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;url,
<a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a>&nbsp;connectContext,
<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>
</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="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#cleanUp()">cleanUp</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>protected <a href="../../../filetransfer/events/IRemoteFileSystemEvent.html" title="interface in org.eclipse.ecf.filetransfer.events">IRemoteFileSystemEvent</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRemoteFileEvent()">createRemoteFileEvent</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>protected <a href="../../../filetransfer/IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRemoteFileSystemRequest()">createRemoteFileSystemRequest</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getException()">getException</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#isCanceled()">isCanceled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>protected <a href="../../../filetransfer/UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer">UserCancelledException</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newUserCancelledException()">newUserCancelledException</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#runRequest()">runRequest</a></span>()</code></th>
<td class="colLast">
<div class="block">Run the actual request.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>protected org.eclipse.core.net.proxy.IProxyData</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData%5B%5D)">selectProxyFromProxies</a></span>&#8203;(<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>&nbsp;protocol,
org.eclipse.core.net.proxy.IProxyData[]&nbsp;proxies)</code></th>
<td class="colLast">
<div class="block">Select a single proxy from a set of proxies available for the given host.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code><a href="../../../filetransfer/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()">sendBrowseRequest</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#setCanceled(java.lang.Exception)">setCanceled</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;e)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setException(java.lang.Exception)">setException</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;exception)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i12">
<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">&nbsp;</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></span>&#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;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="fileID">fileID</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a></span>&nbsp;<span class="memberName">fileID</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="listener">listener</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a></span>&nbsp;<span class="memberName">listener</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="remoteFiles">remoteFiles</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/IRemoteFile.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFile</a>[]</span>&nbsp;<span class="memberName">remoteFiles</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="proxy">proxy</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a></span>&nbsp;<span class="memberName">proxy</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="directoryOrFile">directoryOrFile</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></span>&nbsp;<span class="memberName">directoryOrFile</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="connectContext">connectContext</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></span>&nbsp;<span class="memberName">connectContext</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="job">job</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="AbstractFileSystemBrowser.DirectoryJob.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser.DirectoryJob</a></span>&nbsp;<span class="memberName">job</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="&lt;init&gt;(org.eclipse.ecf.filetransfer.identity.IFileID,org.eclipse.ecf.filetransfer.IRemoteFileSystemListener,java.net.URL,org.eclipse.ecf.core.security.IConnectContext,org.eclipse.ecf.core.util.Proxy)">AbstractFileSystemBrowser</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">AbstractFileSystemBrowser</span>&#8203;(<span class="arguments"><a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a>&nbsp;directoryOrFileID,
<a href="../../../filetransfer/IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a>&nbsp;listener,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;url,
<a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a>&nbsp;connectContext,
<a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a>&nbsp;proxy)</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="cancel()">cancel</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">cancel</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="cleanUp()">cleanUp</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">cleanUp</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="runRequest()">runRequest</a></h3>
<div class="memberSignature"><span class="modifiers">protected abstract</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">runRequest</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></span></div>
<div class="block">Run the actual request. This method is called within the job created to actually get the
directory or file information.</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/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if some problem with making the request or receiving response to the request.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="sendBrowseRequest()">sendBrowseRequest</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></span>&nbsp;<span class="memberName">sendBrowseRequest</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createRemoteFileSystemRequest()">createRemoteFileSystemRequest</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></span>&nbsp;<span class="memberName">createRemoteFileSystemRequest</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createRemoteFileEvent()">createRemoteFileEvent</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/events/IRemoteFileSystemEvent.html" title="interface in org.eclipse.ecf.filetransfer.events">IRemoteFileSystemEvent</a></span>&nbsp;<span class="memberName">createRemoteFileEvent</span>()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>file system directory event</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></h3>
<div class="memberSignature"><span class="modifiers">protected abstract</span>&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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData[])">selectProxyFromProxies</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">org.eclipse.core.net.proxy.IProxyData</span>&nbsp;<span class="memberName">selectProxyFromProxies</span>&#8203;(<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>&nbsp;protocol,
org.eclipse.core.net.proxy.IProxyData[]&nbsp;proxies)</span></div>
<div class="block">Select a single proxy from a set of proxies available for the given host. This implementation
selects in the following manner: 1) If proxies provided is null or array of 0 length, null
is returned. If only one proxy is available (array of length 1) then the entry is returned.
If proxies provided is length greater than 1, then if the type of a proxy in the array matches the given
protocol (e.g. http, https), then the first matching proxy is returned. If the protocol does
not match any of the proxies, then the *first* proxy (i.e. proxies[0]) is returned. Subclasses may
override if desired.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>protocol</code> - the target protocol (e.g. http, https, scp, etc). Will not be <code>null</code>.</dd>
<dd><code>proxies</code> - the proxies to select from. May be <code>null</code> or array of length 0.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>proxy data selected from the proxies provided.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setupProxies()">setupProxies</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setupProxies</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setException(java.lang.Exception)">setException</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setException</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;exception)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getException()">getException</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></span>&nbsp;<span class="memberName">getException</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="isCanceled()">isCanceled</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">isCanceled</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setCanceled(java.lang.Exception)">setCanceled</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setCanceled</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;e)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="newUserCancelledException()">newUserCancelledException</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType"><a href="../../../filetransfer/UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer">UserCancelledException</a></span>&nbsp;<span class="memberName">newUserCancelledException</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractFileSystemBrowser.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><a href="#nested.class.summary">Nested</a>&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><a href="#field.detail">Field</a>&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>