Package org.apache.commons.vfs2.provider
Class AbstractFileSystem
java.lang.Object
org.apache.commons.vfs2.provider.AbstractVfsComponent
org.apache.commons.vfs2.provider.AbstractFileSystem
- All Implemented Interfaces:
Closeable,AutoCloseable,FileSystem,VfsComponent
- Direct Known Subclasses:
CompressedFileFileSystem,FtpFileSystem,Http4FileSystem,Http5FileSystem,HttpFileSystem,LocalFileSystem,RamFileSystem,SftpFileSystem,TarFileSystem,UrlFileSystem,VirtualFileSystem,ZipFileSystem
A partial
FileSystem implementation.-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract voidaddCapabilities(Collection<Capability> caps) Adds the capabilities of this file system.voidaddJunction(String junctionPoint, FileObject targetFile) Adds a junction to this file system.voidaddListener(FileObject file, FileListener listener) Adds a listener on a file in this file system.voidclose()Closes this component.voidCloses the underlying link used to access the files.protected abstract FileObjectcreateFile(AbstractFileName name) Creates a file object.protected FileObjectdecorateFileObject(FileObject file) Decorates the given file object.protected voidCloses the underlying link used to access the files.protected FiledoReplicateFile(FileObject file, FileSelector selector) Creates a temporary local copy of a file and its descendants.voidfireFileChanged(FileObject file) Fires a file changed event.voidfireFileCreated(FileObject file) Fires a file create event.voidfireFileDeleted(FileObject file) Fires a file delete event.getAttribute(String attrName) Gets the attribute with the specified name.protected FileObjectgetFileFromCache(FileName name) Gets a cached file.Gets the FileSystemManager used to instantiate this file system.Gets the FileSystemOptions used to instantiate this file system.doubleGets the accuracy of the last modification time.Gets the parent layer if this is a layered file system.getRoot()Gets the root file of this file system.Gets the name of the root of this file system.Gets the root URI specified for this file System.booleanhasCapability(Capability capability) Tests whether this file system has a particular capability.voidinit()Initializes this component.booleanisOpen()Tests whether this file system has open streams.booleanTests whether any files are using this FileSystem.protected voidCalled after all file-objects closed their streams.protected voidputFileToCache(FileObject file) Adds a file object to the cache.protected voidremoveFileFromCache(FileName name) Removes a cached file.voidremoveJunction(String junctionPoint) Removes a junction from this file system.voidremoveListener(FileObject file, FileListener listener) Removes a listener from a file in this file system.replicateFile(FileObject file, FileSelector selector) Creates a temporary local copy of a file and its descendants.resolveFile(String nameStr) Finds a file in this file system.resolveFile(FileName name) Finds a file in this file system.voidsetAttribute(String attrName, Object value) Sets the attribute with the specified name.Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent
getContext, getLogger, setContext, setLogger
-
Constructor Details
-
AbstractFileSystem
protected AbstractFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance.- Parameters:
rootName- The root file name of this file system.parentLayer- The parent layer of this file system.fileSystemOptions- Options to build this file system.
-
-
Method Details
-
addCapabilities
Adds the capabilities of this file system.- Parameters:
caps- collections of Capabilities, can be immutable.
-
addJunction
Adds a junction to this file system.- Specified by:
addJunctionin interfaceFileSystem- Parameters:
junctionPoint- The junction point.targetFile- The target to add.- Throws:
FileSystemException- if an error occurs.
-
addListener
Adds a listener on a file in this file system.- Specified by:
addListenerin interfaceFileSystem- Parameters:
file- The FileObject to be monitored.listener- The FileListener
-
close
Closes this component.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceVfsComponent- Overrides:
closein classAbstractVfsComponent
-
closeCommunicationLink
Closes the underlying link used to access the files. -
createFile
Creates a file object.This method is called only if the requested file is not cached.
- Parameters:
name- name referencing the new file.- Returns:
- new created FileObject.
- Throws:
Exception- might throw an Exception, which is then wrapped in FileSystemException.
-
decorateFileObject
Decorates the given file object.- Parameters:
file- the file object.- Returns:
- the decorated file object.
- Throws:
FileSystemException- if a file system error occurs.
-
doCloseCommunicationLink
Closes the underlying link used to access the files. -
doReplicateFile
Creates a temporary local copy of a file and its descendants.- Parameters:
file- the start of the tree.selector- selection what to do with children.- Returns:
- replicated root file.
- Throws:
Exception- any Exception is wrapped as FileSystemException.
-
fireFileChanged
Fires a file changed event.This will only happen if you monitor the file using
FileMonitor.- Parameters:
file- The FileObject that changed.
-
fireFileCreated
Fires a file create event.- Parameters:
file- The FileObject that was created.
-
fireFileDeleted
Fires a file delete event.- Parameters:
file- The FileObject that was deleted.
-
getAttribute
Gets the attribute with the specified name. The default implementation simply throws an exception.- Specified by:
getAttributein interfaceFileSystem- Parameters:
attrName- The name of the attribute.- Returns:
- the Object associated with the attribute or null if no object is.
- Throws:
FileSystemException- if an error occurs.- See Also:
-
getFileFromCache
Gets a cached file.- Parameters:
name- name to search for.- Returns:
- file object or null if not found.
-
getFileSystemManager
Gets the FileSystemManager used to instantiate this file system.- Specified by:
getFileSystemManagerin interfaceFileSystem- Returns:
- the FileSystemManager.
-
getFileSystemOptions
Gets the FileSystemOptions used to instantiate this file system.- Specified by:
getFileSystemOptionsin interfaceFileSystem- Returns:
- the FileSystemOptions.
-
getLastModTimeAccuracy
Gets the accuracy of the last modification time.- Specified by:
getLastModTimeAccuracyin interfaceFileSystem- Returns:
- milliseconds, 0 means perfectly accurate,
> 0might be off by this value, for examnple, sftp is 1000 milliseconds.
-
getParentLayer
Gets the parent layer if this is a layered file system.- Specified by:
getParentLayerin interfaceFileSystem- Returns:
- The FileObject for the parent layer.
- Throws:
FileSystemException- if an error occurs.
-
getRoot
Gets the root file of this file system.- Specified by:
getRootin interfaceFileSystem- Returns:
- The root FileObject of the FileSystem
- Throws:
FileSystemException- if an error occurs.
-
getRootName
Gets the name of the root of this file system.- Specified by:
getRootNamein interfaceFileSystem- Returns:
- the root FileName.
-
getRootURI
Gets the root URI specified for this file System.- Specified by:
getRootURIin interfaceFileSystem- Returns:
- The root URI used in this file system.
- Since:
- 2.0
-
hasCapability
Tests whether this file system has a particular capability.- Specified by:
hasCapabilityin interfaceFileSystem- Parameters:
capability- the Capability to check for.- Returns:
- true if the FileSystem has the Capability, false otherwise.
-
init
Initializes this component.- Specified by:
initin interfaceVfsComponent- Overrides:
initin classAbstractVfsComponent- Throws:
FileSystemException- if an error occurs.
-
isOpen
Tests whether this file system has open streams.- Returns:
- true if the FileSystem has open streams.
-
isReleaseable
Tests whether any files are using this FileSystem.- Returns:
- whether any files are using this FileSystem.
-
notifyAllStreamsClosed
Called after all file-objects closed their streams. -
putFileToCache
Adds a file object to the cache.- Parameters:
file- the file to add.
-
removeFileFromCache
Removes a cached file.- Parameters:
name- The file name to remove.
-
removeJunction
Removes a junction from this file system.- Specified by:
removeJunctionin interfaceFileSystem- Parameters:
junctionPoint- The junction point.- Throws:
FileSystemException- if an error occurs
-
removeListener
Removes a listener from a file in this file system.- Specified by:
removeListenerin interfaceFileSystem- Parameters:
file- The FileObject to be monitored.listener- The FileListener
-
replicateFile
Creates a temporary local copy of a file and its descendants.- Specified by:
replicateFilein interfaceFileSystem- Parameters:
file- The FileObject to replicate.selector- The FileSelector.- Returns:
- The replicated File.
- Throws:
FileSystemException- if an error occurs.
-
resolveFile
Finds a file in this file system.- Specified by:
resolveFilein interfaceFileSystem- Parameters:
name- The name of the file to locate.- Returns:
- The located FileObject or null if none could be located.
- Throws:
FileSystemException- if an error occurs.
-
resolveFile
Finds a file in this file system.- Specified by:
resolveFilein interfaceFileSystem- Parameters:
nameStr- The name of the file to resolve.- Returns:
- The located FileObject or null if none could be located.
- Throws:
FileSystemException- if an error occurs.
-
setAttribute
Sets the attribute with the specified name. The default implementation simply throws an exception.- Specified by:
setAttributein interfaceFileSystem- Parameters:
attrName- the attribute name.value- The object to associate with the attribute.- Throws:
FileSystemException- if an error occurs.- See Also:
-