public abstract class AbstractFileSystem extends AbstractVfsComponent implements FileSystem
FileSystem implementation.| Modifier | Constructor and Description |
|---|---|
protected |
AbstractFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
| Modifier and Type | Method and Description |
|---|---|
protected 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 |
closeCommunicationLink()
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 |
doCloseCommunicationLink()
Close the underlying link used to access the files
|
protected 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.
|
Object |
getAttribute(String attrName)
Retrieves the attribute with the specified name.
|
protected FileObject |
getFileFromCache(FileName name)
Returns a cached file.
|
FileSystemManager |
getFileSystemManager()
Return the FileSystemManager used to instantiate this filesystem.
|
FileSystemOptions |
getFileSystemOptions()
Return the FileSystemOptions used to instantiate this filesystem.
|
double |
getLastModTimeAccuracy()
Returns the accuracy of the last modification time.
|
FileObject |
getParentLayer()
Returns the parent layer if this is a layered file system.
|
FileObject |
getRoot()
Returns the root file of this file system.
|
FileName |
getRootName()
Returns the name of the root of this file system.
|
String |
getRootURI()
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 |
isReleaseable()
Returns true if no file is using this filesystem.
|
protected void |
notifyAllStreamsClosed()
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.
|
File |
replicateFile(FileObject file,
FileSelector selector)
Creates a temporary local copy of a file and its descendants.
|
FileObject |
resolveFile(FileName name)
Finds a file in this file system.
|
FileObject |
resolveFile(String nameStr)
Finds a file in this file system.
|
void |
setAttribute(String attrName,
Object value)
Sets the attribute with the specified name.
|
getContext, getLogger, setContext, setLoggerprotected AbstractFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)
public void init()
throws FileSystemException
init in interface VfsComponentinit in class AbstractVfsComponentFileSystemException - if an error occurs.public void close()
close in interface VfsComponentclose in class AbstractVfsComponentpublic void closeCommunicationLink()
protected void doCloseCommunicationLink()
protected abstract FileObject createFile(AbstractFileName name) throws Exception
This method is called only if the requested file is not cached.
name - name referencing the new file.Exception - might throw an Exception, which is then wrapped in FileSystemException.protected abstract void addCapabilities(Collection<Capability> caps)
caps - collections of Capabilities, can be immutable.public FileName getRootName()
getRootName in interface FileSystempublic String getRootURI()
getRootURI in interface FileSystemprotected void putFileToCache(FileObject file)
file - the file to add.protected FileObject getFileFromCache(FileName name)
name - name to search for.protected void removeFileFromCache(FileName name)
name - The file name to remove.public boolean hasCapability(Capability capability)
hasCapability in interface FileSystemcapability - the Capability to check for.public Object getAttribute(String attrName) throws FileSystemException
getAttribute in interface FileSystemattrName - The name of the attribute.FileSystemException - if an error occurs.FileContent.getAttribute(java.lang.String)public void setAttribute(String attrName, Object value) throws FileSystemException
setAttribute in interface FileSystemattrName - the attribute name.value - The object to associate with the attribute.FileSystemException - if an error occurs.FileContent.setAttribute(java.lang.String, java.lang.Object)public FileObject getParentLayer() throws FileSystemException
getParentLayer in interface FileSystemFileSystemException - if an error occurs.public FileObject getRoot() throws FileSystemException
getRoot in interface FileSystemFileSystemException - if an error occurs.public FileObject resolveFile(String nameStr) throws FileSystemException
resolveFile in interface FileSystemnameStr - The name of the file to resolve.FileSystemException - if an error occurs.public FileObject resolveFile(FileName name) throws FileSystemException
resolveFile in interface FileSystemname - The name of the file to locate.FileSystemException - if an error occurs.protected FileObject decorateFileObject(FileObject file) throws FileSystemException
FileSystemExceptionpublic File replicateFile(FileObject file, FileSelector selector) throws FileSystemException
replicateFile in interface FileSystemfile - The FileObject to replicate.selector - The FileSelector.FileSystemException - if an error occurs.public FileSystemOptions getFileSystemOptions()
getFileSystemOptions in interface FileSystempublic FileSystemManager getFileSystemManager()
getFileSystemManager in interface FileSystempublic double getLastModTimeAccuracy()
getLastModTimeAccuracy in interface FileSystemprotected File doReplicateFile(FileObject file, FileSelector selector) throws Exception
file - the start of the tree.selector - selection what to do with childs.Exception - any Exception is wrapped as FileSystemException.public void addJunction(String junctionPoint, FileObject targetFile) throws FileSystemException
addJunction in interface FileSystemjunctionPoint - The junction point.targetFile - The target to add.FileSystemException - if an error occurs.public void removeJunction(String junctionPoint) throws FileSystemException
removeJunction in interface FileSystemjunctionPoint - The junction point.FileSystemException - if an error occurspublic void addListener(FileObject file, FileListener listener)
addListener in interface FileSystemfile - The FileObject to be monitored.listener - The FileListenerpublic void removeListener(FileObject file, FileListener listener)
removeListener in interface FileSystemfile - The FileObject to be monitored.listener - The FileListenerpublic void fireFileCreated(FileObject file)
file - The FileObject that was created.public void fireFileDeleted(FileObject file)
file - The FileObject that was deleted.public void fireFileChanged(FileObject file)
This will only happen if you monitor the file using FileMonitor.
file - The FileObject that changed.public boolean isReleaseable()
protected void notifyAllStreamsClosed()
public boolean isOpen()
Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.