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:
FileSystem
,VfsComponent
- Direct Known Subclasses:
CompressedFileFileSystem
,FtpFileSystem
,HttpFileSystem
,LocalFileSystem
,RamFileSystem
,SftpFileSystem
,TarFileSystem
,UrlFileSystem
,VirtualFileSystem
,ZipFileSystem
A partial
FileSystem
implementation.-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractFileSystem
(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
addCapabilities
(Collection<Capability> caps) Adds the capabilities of this file system.void
addJunction
(String junctionPoint, FileObject targetFile) Adds a junction to this file system.void
addListener
(FileObject file, FileListener listener) Adds a listener on a file in this file system.void
close()
Closes this component.void
Close the underlying link used to access the files.protected abstract FileObject
createFile
(AbstractFileName name) Creates a file object.protected FileObject
decorateFileObject
(FileObject file) protected void
Close the underlying link used to access the filesprotected File
doReplicateFile
(FileObject file, FileSelector selector) Creates a temporary local copy of a file and its descendants.void
fireFileChanged
(FileObject file) Fires a file changed event.void
fireFileCreated
(FileObject file) Fires a file create event.void
fireFileDeleted
(FileObject file) Fires a file delete event.getAttribute
(String attrName) Retrieves the attribute with the specified name.protected FileObject
getFileFromCache
(FileName name) Returns a cached file.Return the FileSystemManager used to instantiate this filesystem.Return the FileSystemOptions used to instantiate this filesystem.double
Returns the accuracy of the last modification time.Returns the parent layer if this is a layered file system.getRoot()
Returns the root file of this file system.Returns the name of the root of this file system.Returns the root URI specified for this file System.boolean
hasCapability
(Capability capability) Determines if this file system has a particular capability.void
init()
Initializes this component.boolean
isOpen()
check if this filesystem has open streams.boolean
Returns true if no file is using this filesystem.protected void
will be called after all file-objects closed their streams.protected void
putFileToCache
(FileObject file) Adds a file object to the cache.protected void
removeFileFromCache
(FileName name) Remove a cached file.void
removeJunction
(String junctionPoint) Removes a junction from this file system.void
removeListener
(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.void
setAttribute
(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)
-
-
Method Details
-
init
Initializes this component.- Specified by:
init
in interfaceVfsComponent
- Overrides:
init
in classAbstractVfsComponent
- Throws:
FileSystemException
- if an error occurs.
-
close
Closes this component.- Specified by:
close
in interfaceVfsComponent
- Overrides:
close
in classAbstractVfsComponent
-
closeCommunicationLink
Close the underlying link used to access the files. -
doCloseCommunicationLink
Close 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.
-
addCapabilities
Adds the capabilities of this file system.- Parameters:
caps
- collections of Capabilities, can be immutable.
-
getRootName
Returns the name of the root of this file system.- Specified by:
getRootName
in interfaceFileSystem
- Returns:
- the root FileName.
-
getRootURI
Returns the root URI specified for this file System.- Specified by:
getRootURI
in interfaceFileSystem
- Returns:
- The root URI used in this file system.
- Since:
- 2.0
-
putFileToCache
Adds a file object to the cache.- Parameters:
file
- the file to add.
-
getFileFromCache
Returns a cached file.- Parameters:
name
- name to search for.- Returns:
- file object or null if not found.
-
removeFileFromCache
Remove a cached file.- Parameters:
name
- The file name to remove.
-
hasCapability
Determines if this file system has a particular capability.- Specified by:
hasCapability
in interfaceFileSystem
- Parameters:
capability
- the Capability to check for.- Returns:
- true if the FileSystem has the Capability, false otherwise.
-
getAttribute
Retrieves the attribute with the specified name. The default implementation simply throws an exception.- Specified by:
getAttribute
in 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:
-
setAttribute
Sets the attribute with the specified name. The default implementation simply throws an exception.- Specified by:
setAttribute
in interfaceFileSystem
- Parameters:
attrName
- the attribute name.value
- The object to associate with the attribute.- Throws:
FileSystemException
- if an error occurs.- See Also:
-
getParentLayer
Returns the parent layer if this is a layered file system.- Specified by:
getParentLayer
in interfaceFileSystem
- Returns:
- The FileObject for the parent layer.
- Throws:
FileSystemException
- if an error occurs.
-
getRoot
Returns the root file of this file system.- Specified by:
getRoot
in interfaceFileSystem
- Returns:
- The root FileObject of the FileSystem
- Throws:
FileSystemException
- if an error occurs.
-
resolveFile
Finds a file in this file system.- Specified by:
resolveFile
in 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.
-
resolveFile
Finds a file in this file system.- Specified by:
resolveFile
in 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.
-
decorateFileObject
- Throws:
FileSystemException
-
replicateFile
Creates a temporary local copy of a file and its descendants.- Specified by:
replicateFile
in interfaceFileSystem
- Parameters:
file
- The FileObject to replicate.selector
- The FileSelector.- Returns:
- The replicated File.
- Throws:
FileSystemException
- if an error occurs.
-
getFileSystemOptions
Return the FileSystemOptions used to instantiate this filesystem.- Specified by:
getFileSystemOptions
in interfaceFileSystem
- Returns:
- the FileSystemOptions.
-
getFileSystemManager
Return the FileSystemManager used to instantiate this filesystem.- Specified by:
getFileSystemManager
in interfaceFileSystem
- Returns:
- the FileSystemManager.
-
getLastModTimeAccuracy
Returns the accuracy of the last modification time.- Specified by:
getLastModTimeAccuracy
in interfaceFileSystem
- Returns:
- ms 0 perfectly accurate, >0 might be off by this value e.g. sftp 1000ms
-
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 childs.- Returns:
- replicated root file.
- Throws:
Exception
- any Exception is wrapped as FileSystemException.
-
addJunction
Adds a junction to this file system.- Specified by:
addJunction
in interfaceFileSystem
- Parameters:
junctionPoint
- The junction point.targetFile
- The target to add.- Throws:
FileSystemException
- if an error occurs.
-
removeJunction
Removes a junction from this file system.- Specified by:
removeJunction
in interfaceFileSystem
- Parameters:
junctionPoint
- The junction point.- Throws:
FileSystemException
- if an error occurs
-
addListener
Adds a listener on a file in this file system.- Specified by:
addListener
in interfaceFileSystem
- Parameters:
file
- The FileObject to be monitored.listener
- The FileListener
-
removeListener
Removes a listener from a file in this file system.- Specified by:
removeListener
in interfaceFileSystem
- Parameters:
file
- The FileObject to be monitored.listener
- The FileListener
-
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.
-
fireFileChanged
Fires a file changed event.This will only happen if you monitor the file using
FileMonitor
.- Parameters:
file
- The FileObject that changed.
-
isReleaseable
Returns true if no file is using this filesystem.- Returns:
- true if no file is using this FileSystem.
-
notifyAllStreamsClosed
will be called after all file-objects closed their streams. -
isOpen
check if this filesystem has open streams.- Returns:
- true if the FileSystem has open streams.
-