Package lumis.portal.filesystem.impl

Class ClusterMirroredLocalDataFile

  • All Implemented Interfaces:
    Serializable, IInputStreamProvider
    public class ClusterMirroredLocalDataFile
extends IFile
    A local data file that has its changes replicated over the cluster.
    Since:
    8.0.0
    Version:
    $Revision: 22716 $ $Date: 2019-05-06 17:16:41 -0300 (Mon, 06 May 2019) $
    See Also:
    Serialized Form

    • Constructor Detail

      • ClusterMirroredLocalDataFile

        public ClusterMirroredLocalDataFile​(String relativePath)
        Creates a new instance for the given relative path.
        Parameters:
        relativePath -
        Since:
        8.0.0

    • Method Detail

      • calculateBasePath

        protected String calculateBasePath()
        Returns the base file system path for this file.
        Returns:
        the base file system path for this file.

      • getFile

        public File getFile()

      • resolve

        public ClusterMirroredLocalDataFile resolve​(String relativePath)
        Description copied from class: IFile
        Resolves the given path against this file. The path must not be an absolute path. In other words, it cannot begin with a /.

        The path of a file is composed by elements separated by /. The resolve process consists in create a new file using this file's relative path concatenated with a / and the given relative path. If the given relative path contains an element .. it means this .. and the previous element will be eliminated (for example my/folder/../file.txt will become my/file.txt).

        Overrides:
        resolve in class IFile
        Parameters:
        relativePath - the relative path to be resolved.
        Returns:
        a file relative to this one.
        See Also:
        PortalFilePath.resolve(String)

      • toLocalDataFile

        public LocalDataFile toLocalDataFile()
        Returns a LocalDataFile of the same relative path of this file.
        Returns:
        a LocalDataFile of the same relative path of this file.
        Since:
        8.0.0

      • delete

        public void delete()
            throws IOException
        Description copied from class: IFile
        Deletes the file or directory. If this denotes a directory, then the directory must be empty in order to be deleted. If this file doesn't exist already, no exception will be raised.
        Throws:
        FileCouldNotBeDeletedException - if this file could not be deleted
        IOException - if other error occur

      • deleteRecursively

        public void deleteRecursively()
                       throws IOException
        Description copied from class: IFile
        Tries to delete the file or directory recursively. If the deletion of some file or directory fails the deletion will not be complete, but some files and/or directories might already have been deleted.

        In other words, it is not guaranteed that either all files and directories will be deleted or none of the files and directories will be deleted.

        If this file doesn't exist already, no exception will be raised.

        Throws:
        FileCouldNotBeDeletedException - if some file or directory couldn't be deleted
        IOException - if other error occur

      • mkdirs

        public void mkdirs()
            throws IOException
        Description copied from class: IFile
        Creates the directory named by this logical filesystem object, including any necessary but nonexistent parent directories. Note that if this operation fails it may have succeeded in creating some of the necessary parent directories.
        Throws:
        DirectoryCouldNotBeCreatedException - if some of the needed directories could not be created
        IOException - if other error occur

      • getInputStream

        public InputStream getInputStream()
                           throws IOException
        Description copied from class: IFile
        Returns an InputStream to be used to read this file.

        If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a FileNotFoundException is thrown.

        The stream must be closed by the caller of this method. A try-finally statement is recommended to guarantee it is closed.

        Specified by:
        getInputStream in interface IInputStreamProvider
        Returns:
        an InputStream to be used to read this file.
        Throws:
        FileNotFoundException - If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading
        IOException - If an I/O error occurred

      • getOutputStream

        public OutputStream getOutputStream()
                             throws IOException
        Description copied from class: IFile
        Returns an OutputStream that writes to this file.

        Any existent content in the file will be discarded and replaced with the content written to this output stream.

        The new file content will only be available after OutputStream.close() is called.

        If the file exists but is a directory rather than a regular file, does not exist but cannot be created, the parent directory does not exist, or cannot be opened for any other reason then a FileNotFoundException is thrown. This exception can be thrown in at any time between this call and the call of OutputStream.close().

        The stream must be closed by the caller of this method. A try-finally statement is recommended to guarantee it is closed.

        Returns:
        an OutputStream to be used to write this file.
        Throws:
        FileNotFoundException - If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
        IOException - If an I/O error occurred

      • setLastModified

        public void setLastModified​(long time)
                     throws IOException
        Description copied from class: IFile
        Sets the last-modified time of the file or directory.
        Parameters:
        time - The new last-modified time, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)
        Throws:
        FileNotFoundException - If this file does not exist
        IOException - if other error occur

      • copyTo

        public void copyTo​(IFile dest)
            throws IOException
        Description copied from class: IFile
        Copies the file denoted by this logical filesystem object.

        This operation will copy this file or directory to the target file or directory using the following criteria:

        • If this file does not exist, a FileNotFoundException will be raised.
        • If this file is a regular file:
          • If the target file does not exist, the target file will be created using this file's content.
          • If the target file is an already existent regular file, the target's content will be replaced by this file's content.
          • If the target file is not a regular file, a FileNotFoundException will be raised.
        • If this file is a directory:
          • If the target file does not exist, the target file will be created as a directory and this file's children will be copied recursively.
          • If the target file is a directory, this file's children will be copied recursively. Those files that already existed in the target but does not exist in this file will not be removed.
          • If the target file exists and is not a directory, a FileNotFoundException will be raised.
          In the case this file is a directory, it is important to notice that if some error occur during the copy of some subfile, some files might already have been copied and/or some directories might already have been created.
        • If this file exists but it isn't neither a regular file nor a directory, a FileNotFoundException will be raised.
        Overrides:
        copyTo in class IFile
        Parameters:
        dest - The new logical filesystem object for the named file
        Throws:
        FileNotFoundException - if this file doesn't exist
        FileCouldNotBeCopiedException - if some error occur during copy
        IOException - if other error occur

      • exists

        public boolean exists()
               throws IOException
        Description copied from class: IFile
        Tests whether the file or directory exists.
        Specified by:
        exists in class IFile
        Returns:
        true if and only if the file or directory exists; false otherwise
        Throws:
        IOException - if some error occur during this operation

      • isDirectory

        public boolean isDirectory()
                    throws IOException
        Description copied from class: IFile
        Tests whether the file is a directory.
        Specified by:
        isDirectory in class IFile
        Returns:
        true if and only if the file exists and is a directory; false otherwise
        Throws:
        IOException - if some error occur during this operation

      • isFile

        public boolean isFile()
               throws IOException
        Description copied from class: IFile
        Tests whether the file denoted by this IFile is an actual file. This test might be system-dependent.
        Specified by:
        isFile in class IFile
        Returns:
        true if and only if the file denoted by this IFile exists and is an actual file; false otherwise
        Throws:
        IOException - if some error occur during this operation

      • listFiles

        public IFile[] listFiles()
                  throws IOException
        Description copied from class: IFile
        Lists all immediate sub files and directories of this directory (the files and directories whose IFile.getParent() is equal to this).
        Specified by:
        listFiles in class IFile
        Returns:
        all immediate sub files and directories of this directory; an empty list if this directory has no files and no directories.
        Throws:
        FileNotFoundException - if this file doesn't exist
        FileIsNotDirectoryException - if this file does not denote a directory
        IOException - if other error occur

      • getLastModified

        public long getLastModified()
                     throws IOException
        Description copied from class: IFile
        Returns the time that the file or directory was last modified.
        Specified by:
        getLastModified in class IFile
        Returns:
        A long value representing the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)
        Throws:
        FileNotFoundException - If this file does not exist
        IOException - if other error occur

      • copyRegularFileTo

        protected void copyRegularFileTo​(IFile dest)
                          throws IOException
        Description copied from class: IFile
        Copies this file, assuming it is a regular file, to the specified destination.
        Overrides:
        copyRegularFileTo in class IFile
        Parameters:
        dest - the copy destination.
        Throws:
        IOException - if I/O error occurred.

      • write

        public void write​(InputStream inputStream)
           throws IOException
        Description copied from class: IFile
        Copies the given input stream's content into this file.
        Overrides:
        write in class IFile
        Parameters:
        inputStream - the input stream.
        Throws:
        IOException

      • readBytes

        public byte[] readBytes()
                 throws IOException
        Description copied from class: IFile
        Reads this file content in bytes.
        Overrides:
        readBytes in class IFile
        Returns:
        this file content in bytes.
        Throws:
        IOException