Package org.apache.commons.vfs2.provider
Interface FileProvider
-
- All Known Subinterfaces:
LocalFileProvider
- All Known Implementing Classes:
AbstractFileProvider
,AbstractLayeredFileProvider
,AbstractOriginatingFileProvider
,Bzip2FileProvider
,CompositeFileProvider
,CompressedFileFileProvider
,DefaultLocalFileProvider
,FtpFileProvider
,GzipFileProvider
,Http4FileProvider
,Http4sFileProvider
,HttpFileProvider
,HttpsFileProvider
,JarFileProvider
,RamFileProvider
,ResourceFileProvider
,SftpFileProvider
,TarFileProvider
,Tbz2FileProvider
,TemporaryFileProvider
,TgzFileProvider
,UrlFileProvider
,ZipFileProvider
public interface FileProvider
A file provider. Each file provider is responsible for handling files for a particular URI scheme.A file provider may also implement
VfsComponent
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FileObject
createFileSystem(java.lang.String scheme, FileObject file, FileSystemOptions fileSystemOptions)
Creates a layered file system.FileObject
findFile(FileObject baseFile, java.lang.String uri, FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.java.util.Collection<Capability>
getCapabilities()
Gets the file system capabilities.FileSystemConfigBuilder
getConfigBuilder()
Gets the configbuilder usable to collect the needed fileSystemOptions.FileName
parseUri(FileName root, java.lang.String uri)
Parses the URI into a FileName.
-
-
-
Method Detail
-
createFileSystem
FileObject createFileSystem(java.lang.String scheme, FileObject file, FileSystemOptions fileSystemOptions) throws FileSystemException
Creates a layered file system.- Parameters:
scheme
- The URI scheme for the layered file system.file
- The file to build the file system on.fileSystemOptions
- The FileSystemOptions.- Returns:
- A FileObject in the file system.
- Throws:
FileSystemException
- if an error occurs.
-
findFile
FileObject findFile(FileObject baseFile, java.lang.String uri, FileSystemOptions fileSystemOptions) throws FileSystemException
Locates a file object, by absolute URI.- Parameters:
baseFile
- The base file to use for resolving the individual parts of a compound URI.uri
- The absolute URI of the file to find.fileSystemOptions
- The FileSystemOptions- Returns:
- The FileObject.
- Throws:
FileSystemException
- if an error occurs locating the file.
-
getCapabilities
java.util.Collection<Capability> getCapabilities()
Gets the file system capabilities.These are the same as on the file system, but available before the first file system was instantiated.
- Returns:
- a Collection of the file systems Capabilities.
-
getConfigBuilder
FileSystemConfigBuilder getConfigBuilder()
Gets the configbuilder usable to collect the needed fileSystemOptions.- Returns:
- a FileSystemConfigBuilder for the particular file system.
-
parseUri
FileName parseUri(FileName root, java.lang.String uri) throws FileSystemException
Parses the URI into a FileName.- Parameters:
root
- The base FileName.uri
- The file to be accessed.- Returns:
- A FileName representing the target file.
- Throws:
FileSystemException
- if an error occurs.
-
-