| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>HttpClientFileSystemBrowser (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: HttpClientFileSystemBrowser"> |
| <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}; |
| 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/HttpClientFileSystemBrowser.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><a href="#nested.class.summary">Nested</a> | </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 HttpClientFileSystemBrowser" class="title">Class HttpClientFileSystemBrowser</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="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">org.eclipse.ecf.provider.filetransfer.browse.AbstractFileSystemBrowser</a> |
| <div class="inheritance">org.eclipse.ecf.provider.filetransfer.httpclient45.HttpClientFileSystemBrowser</div> |
| </div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">HttpClientFileSystemBrowser</span> |
| extends <a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></pre> |
| </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="inheritedList"> |
| <h2>Nested classes/interfaces inherited from class org.eclipse.ecf.provider.filetransfer.browse.<a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></h2> |
| <a id="nested.classes.inherited.from.class.org.eclipse.ecf.provider.filetransfer.browse.AbstractFileSystemBrowser"> |
| <!-- --> |
| </a><code><a href="../browse/AbstractFileSystemBrowser.DirectoryJob.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser.DirectoryJob</a>, <a href="../browse/AbstractFileSystemBrowser.RemoteFileSystemRequest.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser.RemoteFileSystemRequest</a></code></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"> </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 static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONNECTION_TIMEOUT">DEFAULT_CONNECTION_TIMEOUT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.client.methods.HttpHead</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#headMethod">headMethod</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.http.impl.client.CloseableHttpClient</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpClient">httpClient</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.client.protocol.HttpClientContext</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpContext">httpContext</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">This is the context used to retain information about the request that |
| the <code>HttpClient</code> gathers during the request.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.http.client.methods.CloseableHttpResponse</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpResponse">httpResponse</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">This is the response returned by <code>HttpClient</code> when it executes |
| <a href="#headMethod"><code>headMethod</code></a>.</div> |
| </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/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="#password">password</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <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="#username">username</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.browse.<a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></h3> |
| <a id="fields.inherited.from.class.org.eclipse.ecf.provider.filetransfer.browse.AbstractFileSystemBrowser"> |
| <!-- --> |
| </a><code><a href="../browse/AbstractFileSystemBrowser.html#connectContext">connectContext</a>, <a href="../browse/AbstractFileSystemBrowser.html#directoryOrFile">directoryOrFile</a>, <a href="../browse/AbstractFileSystemBrowser.html#fileID">fileID</a>, <a href="../browse/AbstractFileSystemBrowser.html#job">job</a>, <a href="../browse/AbstractFileSystemBrowser.html#listener">listener</a>, <a href="../browse/AbstractFileSystemBrowser.html#proxy">proxy</a>, <a href="../browse/AbstractFileSystemBrowser.html#remoteFiles">remoteFiles</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,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)">HttpClientFileSystemBrowser</a></span>​(org.apache.http.impl.client.CloseableHttpClient httpClient, |
| <a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> directoryOrFileID, |
| <a href="../../../filetransfer/IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a> 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> directoryOrFileURL, |
| <a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext, |
| <a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</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="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="#cancel()">cancel</a></span>()</code></th> |
| <td class="colLast"> </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"> </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="#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="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"> </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <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"> |
| <div class="block">Retrieves the credentials for requesting the file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>protected 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="i6"> |
| <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="rowColor" id="i7"> |
| <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="altColor" id="i8"> |
| <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"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.eclipse.ecf.provider.filetransfer.browse.<a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.provider.filetransfer.browse.AbstractFileSystemBrowser"> |
| <!-- --> |
| </a><code><a href="../browse/AbstractFileSystemBrowser.html#createRemoteFileEvent()">createRemoteFileEvent</a>, <a href="../browse/AbstractFileSystemBrowser.html#getException()">getException</a>, <a href="../browse/AbstractFileSystemBrowser.html#isCanceled()">isCanceled</a>, <a href="../browse/AbstractFileSystemBrowser.html#newUserCancelledException()">newUserCancelledException</a>, <a href="../browse/AbstractFileSystemBrowser.html#selectProxyFromProxies(java.lang.String,org.eclipse.core.net.proxy.IProxyData%5B%5D)">selectProxyFromProxies</a>, <a href="../browse/AbstractFileSystemBrowser.html#sendBrowseRequest()">sendBrowseRequest</a>, <a href="../browse/AbstractFileSystemBrowser.html#setCanceled(java.lang.Exception)">setCanceled</a>, <a href="../browse/AbstractFileSystemBrowser.html#setException(java.lang.Exception)">setException</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="DEFAULT_CONNECTION_TIMEOUT">DEFAULT_CONNECTION_TIMEOUT</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType">int</span> <span class="memberName">DEFAULT_CONNECTION_TIMEOUT</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="username">username</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">username</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="password">password</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">password</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="httpClient">httpClient</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.apache.http.impl.client.CloseableHttpClient</span> <span class="memberName">httpClient</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="headMethod">headMethod</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected volatile</span> <span class="returnType">org.apache.http.client.methods.HttpHead</span> <span class="memberName">headMethod</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="httpResponse">httpResponse</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected volatile</span> <span class="returnType">org.apache.http.client.methods.CloseableHttpResponse</span> <span class="memberName">httpResponse</span></div> |
| <div class="block">This is the response returned by <code>HttpClient</code> when it executes |
| <a href="#headMethod"><code>headMethod</code></a>.</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="httpContext">httpContext</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected volatile</span> <span class="returnType">org.apache.http.client.protocol.HttpClientContext</span> <span class="memberName">httpContext</span></div> |
| <div class="block">This is the context used to retain information about the request that |
| the <code>HttpClient</code> gathers during the request.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </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,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)">HttpClientFileSystemBrowser</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">HttpClientFileSystemBrowser</span>​(<span class="arguments">org.apache.http.impl.client.CloseableHttpClient httpClient, |
| <a href="../../../filetransfer/identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a> directoryOrFileID, |
| <a href="../../../filetransfer/IRemoteFileSystemListener.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemListener</a> 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> directoryOrFileURL, |
| <a href="../../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext, |
| <a href="../../../core/util/Proxy.html" title="class in org.eclipse.ecf.core.util">Proxy</a> proxy)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>httpClient</code> - http client</dd> |
| <dd><code>directoryOrFileID</code> - directory or file id</dd> |
| <dd><code>listener</code> - listener</dd> |
| <dd><code>directoryOrFileURL</code> - directory or file id</dd> |
| <dd><code>connectContext</code> - connect context</dd> |
| <dd><code>proxy</code> - proxy</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </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="createRemoteFileSystemRequest()">createRemoteFileSystemRequest</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../../filetransfer/IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer">IRemoteFileSystemRequest</a></span> <span class="memberName">createRemoteFileSystemRequest</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../browse/AbstractFileSystemBrowser.html#createRemoteFileSystemRequest()">createRemoteFileSystemRequest</a></code> in class <code><a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cancel()">cancel</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">cancel</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../browse/AbstractFileSystemBrowser.html#cancel()">cancel</a></code> in class <code><a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></code></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="../browse/AbstractFileSystemBrowser.html#setupProxies()">setupProxies</a></code> in class <code><a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cleanUp()">cleanUp</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">cleanUp</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../browse/AbstractFileSystemBrowser.html#cleanUp()">cleanUp</a></code> in class <code><a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="runRequest()">runRequest</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../browse/AbstractFileSystemBrowser.html#runRequest()">AbstractFileSystemBrowser</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../browse/AbstractFileSystemBrowser.html#runRequest()">runRequest</a></code> in class <code><a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></code></dd> |
| <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="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> |
| <div class="block">Retrieves the credentials for requesting the file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Credentials</code> necessary to retrieve the file</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 the callback fails</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 IO fails</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</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="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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../browse/AbstractFileSystemBrowser.html#setupProxy(org.eclipse.ecf.core.util.Proxy)">setupProxy</a></code> in class <code><a href="../browse/AbstractFileSystemBrowser.html" title="class in org.eclipse.ecf.provider.filetransfer.browse">AbstractFileSystemBrowser</a></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> |
| </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/HttpClientFileSystemBrowser.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><a href="#nested.class.summary">Nested</a> | </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> |
