org.apache.commons.vfs.provider
Class AbstractOriginatingFileProvider
java.lang.Object
org.apache.commons.vfs.provider.AbstractVfsComponent
org.apache.commons.vfs.provider.AbstractVfsContainer
org.apache.commons.vfs.provider.AbstractFileProvider
org.apache.commons.vfs.provider.AbstractOriginatingFileProvider
- All Implemented Interfaces:
- FileProvider, VfsComponent
- Direct Known Subclasses:
- DefaultLocalFileProvider, FtpFileProvider, HttpFileProvider, RamFileProvider, SftpFileProvider, SmbFileProvider
public abstract class AbstractOriginatingFileProvider
- extends AbstractFileProvider
A FileProvider
that handles physical files, such as the files in a
local fs, or on an FTP server. An originating file system cannot be
layered on top of another file system.
- Version:
- $Revision: 804273 $ $Date: 2009-08-14 17:56:52 +0200(ven, 14 ago 2009) $
- Author:
- Adam Murdoch
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AbstractOriginatingFileProvider
public AbstractOriginatingFileProvider()
findFile
public FileObject findFile(FileObject baseFile,
String uri,
FileSystemOptions fileSystemOptions)
throws FileSystemException
- Locates a file object, by absolute URI.
- Parameters:
baseFile
- The base file object.uri
- The URI of the file to locatefileSystemOptions
- The FileSystem options.
- Returns:
- The located FileObject
- Throws:
FileSystemException
- if an error occurs.
findFile
protected FileObject findFile(FileName name,
FileSystemOptions fileSystemOptions)
throws FileSystemException
- Locates a file from its parsed URI.
- Parameters:
name
- The file name.fileSystemOptions
- FileSystem options.
- Returns:
- A FileObject associated with the file.
- Throws:
FileSystemException
- if an error occurs.
getFileSystem
protected FileSystem getFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions)
throws FileSystemException
- Returns the FileSystem associated with the specified root.
- Parameters:
rootName
- The root path.fileSystemOptions
- The FileSystem options.
- Returns:
- The FileSystem.
- Throws:
FileSystemException
- if an error occurs.
doCreateFileSystem
protected abstract FileSystem doCreateFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions)
throws FileSystemException
- Creates a
FileSystem
. If the returned FileSystem implements
VfsComponent
, it will be initialised.
- Parameters:
rootName
- The name of the root file of the file system to create.fileSystemOptions
- The FileSystem options.
- Returns:
- The FileSystem.
- Throws:
FileSystemException
- if an error occurs.
Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.