org.das2.util.filesystem

Class FTPFileSystem

java.lang.Object

org.das2.util.filesystem.FileSystem

org.das2.util.filesystem.WebFileSystem

org.das2.util.filesystem.FTPFileSystem

public class FTPFileSystem
extends WebFileSystem

This original FtpFileSystem implementation is based on Java's FTP client. Note, Autoplot uses a third-party library because of limitations of the Java implementation. See DataSource project of Autoplot. TODO: like what?

Nested Class Summary

Nested classes/interfaces inherited from class org.das2.util.filesystem.FileSystem

FileSystem.DirectoryEntry, FileSystem.FileSystemOfflineException

Field Summary

Fields inherited from class org.das2.util.filesystem.WebFileSystem

HTTP_CHECK_TIMESTAMP_LIMIT_MS, id, LISTING_TIMEOUT_MS, localRoot, logger, MEMORY_LISTING_TIMEOUT_MS, offline, offlineMessage, offlineResponseCode, PROP_OFFLINE, PROP_READ_ONLY_CACHE, protocol

Fields inherited from class org.das2.util.filesystem.FileSystem

loggerUrl, NULL, PROP_CASE_INSENSITIVE, properties

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.String>	downloadFile(java.lang.String filename, java.io.File targetFile, java.io.File partFile, ProgressMonitor monitor) Transfers the file from the remote store to a local copy f.
boolean	isDirectory(java.lang.String filename) return true if the name refers to a directory, not a file.
java.lang.String[]	listDirectory(java.lang.String directory) return the directory listing for the name.

Methods inherited from class org.das2.util.filesystem.WebFileSystem

addPropertyChangeListener, addRoCacheEntries, cacheListing, consumeStream, copyStream, getDownloadDirectory, getDownloadLock, getFileObject, getLastAccessed, getLocalName, getLocalName, getLocalRoot, getLocalRootAbsPath, getOfflineMessage, getOfflineResponseCode, getPartFile, getProtocol, getReadOnlyCache, getRootURL, getURI, getURL, isAppletMode, isGitClone, isListingCached, isOffline, listDirectory, listDirectoryFromMemory, listingFile, localRoot, maybeUpdateDirectoryEntry, removePropertyChangeListener, resetListCache, resetListingCache, setAppletMode, setOffline, setReadOnlyCache, toString

Methods inherited from class org.das2.util.filesystem.FileSystem

create, create, create, create, create, create, createFileSystem, getExceptionHandler, getListing, getListing, getProperty, getRootURI, listDirectory, listDirectory, listDirectoryDeep, peek, peekInstances, recreate, recreate, registerFileSystemFactory, reset, reset, setExceptionHandler, settings, splitUrl, toCanonicalFilename, toCanonicalFolderName, toCanonicalFolderName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isDirectory

public boolean isDirectory(java.lang.String filename)

Description copied from class: WebFileSystem

return true if the name refers to a directory, not a file.

Specified by:

isDirectory in class WebFileSystem

Parameters:

filename - the name

Returns:

true if the name is a directory.

listDirectory

public java.lang.String[] listDirectory(java.lang.String directory)

Description copied from class: WebFileSystem

return the directory listing for the name.

Specified by:

listDirectory in class WebFileSystem

Parameters:

directory - the directory name within the filesystem.

Returns:

list of files and folders within the filesystem.

downloadFile

protected java.util.Map<java.lang.String,java.lang.String> downloadFile(java.lang.String filename,
                                                                        java.io.File targetFile,
                                                                        java.io.File partFile,
                                                                        ProgressMonitor monitor)
                                                                 throws java.io.IOException

Description copied from class: WebFileSystem

Transfers the file from the remote store to a local copy f. This should only be used within the class and subclasses, clients should use getFileObject( String ).getFile(). Subclasses implementing this should download data to partfile, then rename partfile to f after the download is complete. Note, this is non-trivial, since several threads and even several processes may be using the same area at once. See HttpFileSystem's implementation of this before attempting to implement the function.

Specified by:

downloadFile in class WebFileSystem

Parameters:

filename - the name of the file, relative to the filesystem.

targetFile - the file to where the file is downloaded.

partFile - the temporary file during download.

monitor - progress monitor

Returns:

metadata headers from the load, if any are available. See WebProtocol.

Throws:

java.io.IOException

See Also:

WebProtocol.getMetadata(org.das2.util.filesystem.WebFileObject)