Class AbstractFileSystemBrowser
- java.lang.Object
- 
- org.eclipse.ecf.provider.filetransfer.browse.AbstractFileSystemBrowser
 
- 
- Direct Known Subclasses:
- HttpClientFileSystemBrowser,- HttpClientFileSystemBrowser,- HttpClientFileSystemBrowser,- LocalFileSystemBrowser,- URLFileSystemBrowser
 
 public abstract class AbstractFileSystemBrowser extends Object Abstract class for browsing an efs file system.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description protected classAbstractFileSystemBrowser.DirectoryJobclassAbstractFileSystemBrowser.RemoteFileSystemRequest
 - 
Field SummaryFields Modifier and Type Field Description protected IConnectContextconnectContextprotected URLdirectoryOrFileprotected IFileIDfileIDprotected AbstractFileSystemBrowser.DirectoryJobjobprotected IRemoteFileSystemListenerlistenerprotected Proxyproxyprotected IRemoteFile[]remoteFiles
 - 
Constructor SummaryConstructors Constructor Description AbstractFileSystemBrowser(IFileID directoryOrFileID, IRemoteFileSystemListener listener, URL url, IConnectContext connectContext, Proxy proxy)
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidcancel()protected voidcleanUp()protected IRemoteFileSystemEventcreateRemoteFileEvent()protected IRemoteFileSystemRequestcreateRemoteFileSystemRequest()protected ExceptiongetException()protected booleanisCanceled()protected UserCancelledExceptionnewUserCancelledException()protected abstract voidrunRequest()Run the actual request.protected org.eclipse.core.net.proxy.IProxyDataselectProxyFromProxies(String protocol, org.eclipse.core.net.proxy.IProxyData[] proxies)Select a single proxy from a set of proxies available for the given host.IRemoteFileSystemRequestsendBrowseRequest()protected voidsetCanceled(Exception e)protected voidsetException(Exception exception)protected voidsetupProxies()protected abstract voidsetupProxy(Proxy proxy)
 
- 
- 
- 
Field Detail- 
fileIDprotected IFileID fileID 
 - 
listenerprotected IRemoteFileSystemListener listener 
 - 
remoteFilesprotected IRemoteFile[] remoteFiles 
 - 
proxyprotected Proxy proxy 
 - 
directoryOrFileprotected URL directoryOrFile 
 - 
connectContextprotected IConnectContext connectContext 
 - 
jobprotected AbstractFileSystemBrowser.DirectoryJob job 
 
- 
 - 
Constructor Detail- 
AbstractFileSystemBrowserpublic AbstractFileSystemBrowser(IFileID directoryOrFileID, IRemoteFileSystemListener listener, URL url, IConnectContext connectContext, Proxy proxy) 
 
- 
 - 
Method Detail- 
cancelprotected void cancel() 
 - 
cleanUpprotected void cleanUp() 
 - 
runRequestprotected abstract void runRequest() throws ExceptionRun the actual request. This method is called within the job created to actually get the directory or file information.- Throws:
- Exception- if some problem with making the request or receiving response to the request.
 
 - 
sendBrowseRequestpublic IRemoteFileSystemRequest sendBrowseRequest() 
 - 
createRemoteFileSystemRequestprotected IRemoteFileSystemRequest createRemoteFileSystemRequest() 
 - 
createRemoteFileEventprotected IRemoteFileSystemEvent createRemoteFileEvent() - Returns:
- file system directory event
 
 - 
setupProxyprotected abstract void setupProxy(Proxy proxy) 
 - 
selectProxyFromProxiesprotected org.eclipse.core.net.proxy.IProxyData selectProxyFromProxies(String protocol, org.eclipse.core.net.proxy.IProxyData[] proxies) 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.- Parameters:
- protocol- the target protocol (e.g. http, https, scp, etc). Will not be- null.
- proxies- the proxies to select from. May be- nullor array of length 0.
- Returns:
- proxy data selected from the proxies provided.
 
 - 
setupProxiesprotected void setupProxies() 
 - 
setExceptionprotected void setException(Exception exception) 
 - 
getExceptionprotected Exception getException() 
 - 
isCanceledprotected boolean isCanceled() 
 - 
setCanceledprotected void setCanceled(Exception e) 
 - 
newUserCancelledExceptionprotected UserCancelledException newUserCancelledException() 
 
- 
 
-