Interface FileSystem

    • Method Detail

      • getRootName

        FileName getRootName()
        Returns the name of the root file of this file system. The root name always contains a path String of "/".
        Returns:
        the root FileName.
      • getRootURI

        java.lang.String getRootURI()
        The root URI passed as a file system option or obtained from the rootName.
        Returns:
        The root URI.
      • hasCapability

        boolean hasCapability​(Capability capability)
        Determines if this file system has a particular capability.

        TODO - Move this to another interface, so that set of capabilities can be queried.

        Parameters:
        capability - The capability to check for.
        Returns:
        true if this filesystem has the requested capability. Note that not all files in the file system may have the capability.
      • getAttribute

        java.lang.Object getAttribute​(java.lang.String attrName)
                               throws FileSystemException
        Gets the value of an attribute of the file system.

        TODO - change to Map getAttributes() instead?
        TODO - define the standard attribute names, and define which attrs are guaranteed to be present.

        Parameters:
        attrName - The name of the attribute.
        Returns:
        The value of the attribute.
        Throws:
        FileSystemException - If the file does not exist, or is being written, or if the attribute is unknown.
        See Also:
        FileContent.getAttribute(java.lang.String)
      • addListener

        void addListener​(FileObject file,
                         FileListener listener)
        Adds a listener on a file in this file system.
        Parameters:
        file - The file to attach the listener to.
        listener - The listener to add.
      • removeListener

        void removeListener​(FileObject file,
                            FileListener listener)
        Removes a listener from a file in this file system.
        Parameters:
        file - The file to remove the listener from.
        listener - The listener to remove.
      • addJunction

        void addJunction​(java.lang.String junctionPoint,
                         FileObject targetFile)
                  throws FileSystemException
        Adds a junction to this file system. A junction is a link that attaches the supplied file to a point in this file system, making it look like part of the file system.
        Parameters:
        junctionPoint - The point in this file system to add the junction.
        targetFile - The file to link to.
        Throws:
        FileSystemException - If this file system does not support junctions, or the junction point or target file is invalid (the file system may not support nested junctions, for example).
      • replicateFile

        java.io.File replicateFile​(FileObject file,
                                   FileSelector selector)
                            throws FileSystemException
        Creates a temporary local copy of a file and its descendants. If this file is already a local file, a copy is not made.

        Note that the local copy may include additonal files, that were not selected by the given selector.

        TODO - Add options to indicate whether the caller is happy to deal with extra files being present locally (eg if the file has been replicated previously), or whether the caller expects only the selected files to be present.

        Parameters:
        file - The file to replicate.
        selector - The selector to use to select the files to replicate.
        Returns:
        The local copy of this file.
        Throws:
        FileSystemException - If this file does not exist, or on error replicating the file.
      • getLastModTimeAccuracy

        double getLastModTimeAccuracy()
        Returns the accuracy of the last modification time.

        The local file provider is not very smart in figuring this out, for remote access to file systems the providers typically don't know the value of the underlying real file system.

        Returns:
        the accuracy of the last modification time in milliseconds. A value of 0 means perfectly accurate, anything > 0 might be off by this value. For example, sftp has an accuracy of 1000 ms.