org.das2.util.filesystem

Class VFSFileSystem

java.lang.Object

org.das2.util.filesystem.FileSystem

org.das2.util.filesystem.VFSFileSystem

public class VFSFileSystem
extends FileSystem

FileSystem provides additional abstraction to Apache VFS to implement das2 FileSystems, and provide SFTP access.

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.FileSystem

logger, loggerUrl, NULL, PROP_CASE_INSENSITIVE, properties

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	copyStream(java.io.InputStream is, java.io.OutputStream out, ProgressMonitor monitor) copies data from in to out, sending the number of bytesTransferred to the monitor.
static VFSFileSystem	createVFSFileSystem(java.net.URI root)
static VFSFileSystem	createVFSFileSystem(java.net.URI root, boolean createFolder)
protected void	downloadFile(java.lang.String filename, java.io.File f, java.io.File partfile, ProgressMonitor monitor) Transfers the file from the remote store to a local copy f.
protected void	finalize()
protected java.util.concurrent.locks.Lock	getDownloadLock(java.lang.String filename, java.io.File f, ProgressMonitor monitor) Request lock to download file.
FileObject	getFileObject(java.lang.String filename) return the FileObject that corresponds to the name.
java.io.File	getLocalRoot() return the folder that is a local copy of the filesystem.
protected org.apache.commons.vfs.FileObject	getVFSFileObject()
boolean	isDirectory(java.lang.String filename) return true if the name is a directory.
boolean	isLocal()
java.lang.String[]	listDirectory(java.lang.String directory) return a list of files and folders in the directory.
java.lang.String[]	listDirectory(java.lang.String directory, java.lang.String regex) returns a list of the names of the files in a directory that match regex.

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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public void close()

createVFSFileSystem

public static VFSFileSystem createVFSFileSystem(java.net.URI root)
                                         throws FileSystem.FileSystemOfflineException,
                                                java.net.UnknownHostException

Throws:

FileSystem.FileSystemOfflineException

java.net.UnknownHostException

createVFSFileSystem

public static VFSFileSystem createVFSFileSystem(java.net.URI root,
                                                boolean createFolder)
                                         throws FileSystem.FileSystemOfflineException,
                                                java.net.UnknownHostException

Throws:

FileSystem.FileSystemOfflineException

java.net.UnknownHostException

getVFSFileObject

protected org.apache.commons.vfs.FileObject getVFSFileObject()
                                                      throws FileSystemException

Throws:

FileSystemException

getFileObject

public FileObject getFileObject(java.lang.String filename)

Description copied from class: FileSystem

return the FileObject that corresponds to the name.

Specified by:

getFileObject in class FileSystem

Parameters:

filename - the file name within the filesystem

Returns:

the FileObject

isDirectory

public boolean isDirectory(java.lang.String filename)
                    throws java.io.IOException

Description copied from class: FileSystem

return true if the name is a directory.

Specified by:

isDirectory in class FileSystem

Parameters:

filename - the name

Returns:

true if the name is a directory.

Throws:

java.io.IOException

listDirectory

public java.lang.String[] listDirectory(java.lang.String directory)
                                 throws java.io.IOException

return a list of files and folders in the directory. Conventionally, folders are identified with a trailing slash.

Specified by:

listDirectory in class FileSystem

Parameters:

directory -

Returns:

Throws:

java.io.IOException

See Also:

for listings constrained by regular expressions.

listDirectory

public java.lang.String[] listDirectory(java.lang.String directory,
                                        java.lang.String regex)
                                 throws java.io.IOException

Description copied from class: FileSystem

returns a list of the names of the files in a directory that match regex. Trailing slashes on directory names are not part of the name and need not be part of the regex. Note regex is a regular expression (.*\.dat), not a glob (*.dat)

Specified by:

listDirectory in class FileSystem

Parameters:

directory - the directory

regex - regular expression

Returns:

Throws:

java.io.IOException

getLocalRoot

public java.io.File getLocalRoot()

Description copied from class: FileSystem

return the folder that is a local copy of the filesystem. For LocalFilesystem, this is the same as the filesystem. For remote filesystems, this is a folder within their home directory. Note File.getAbsolutePath() returns the string representation of this root.

Specified by:

getLocalRoot in class FileSystem

Returns:

the folder that is a local copy of the filesystem.

isLocal

public boolean isLocal()

getDownloadLock

protected java.util.concurrent.locks.Lock getDownloadLock(java.lang.String filename,
                                                          java.io.File f,
                                                          ProgressMonitor monitor)
                                                   throws java.io.IOException

Request lock to download file. If this thread gets the lock, then it should download the file and call mutatorLock.unlock() when the download is complete. If another thread is downloading the file, this will block until the download is complete, and null will be returned to indicate that the file has already been downloaded. This must start the monitor when it gets the lock.

Parameters:

filename - the filename with in the filesystem.

f - the File which will be the local copy.

monitor - a monitor for the download. If a MutatorLock is returned, then the monitor is not touched, but other threads may use it to keep track of the download progress.

Returns:

MutatorLock. The client should call mutatorLock.unlock() when the download is complete

Throws:

java.io.FileNotFoundException - if the file wasn't found after another thread loaded the file.

java.io.IOException

copyStream

protected void copyStream(java.io.InputStream is,
                          java.io.OutputStream out,
                          ProgressMonitor monitor)
                   throws java.io.IOException

copies data from in to out, sending the number of bytesTransferred to the monitor.

Parameters:

is - the input stream source of data

out - the output stream to where the data is copied.

monitor - monitor for the transfer, where only setTaskProgress and isCancelled are called.

Throws:

java.io.IOException - if the transfer is interrupted.

downloadFile

protected void downloadFile(java.lang.String filename,
                            java.io.File f,
                            java.io.File partfile,
                            ProgressMonitor monitor)
                     throws java.io.IOException

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().

Parameters:

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

f - the file to where the file is downloaded.

partfile - the temporary file during download.

monitor - progress monitor

Throws:

java.io.IOException

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable