Package org.apache.ftpserver.ftplet

Interface FileSystemView

public interface FileSystemView
This is an abstraction over the user file system view.
Author:
Apache MINA Project

  • Method Details

    • getHomeDirectory

      FtpFile getHomeDirectory() throws FtpException
      Get the user home directory.
      Returns:
      The FtpFile for the users home directory
      Throws:
      FtpException - When the Home Directory can't be retrieved

    • getWorkingDirectory

      FtpFile getWorkingDirectory() throws FtpException
      Get user current directory.
      Returns:
      The FtpFile for the users current directory
      Throws:
      FtpException - When the working Directory can't be retrieved

    • changeWorkingDirectory

      boolean changeWorkingDirectory(String dir) throws FtpException
      Change directory.
      Parameters:
      dir - The path of the directory to set as the current directory for the user
      Returns:
      true if successful
      Throws:
      FtpException - When the change to Home Directory can't be done

    • getFile

      FtpFile getFile(String file) throws FtpException
      Get file object.
      Parameters:
      file - The path to the file to get
      Returns:
      The FtpFile for the provided path
      Throws:
      FtpException - When the file can't be retrieved

    • isRandomAccessible

      boolean isRandomAccessible() throws FtpException
      Does the file system support random file access?
      Returns:
      true if the file supports random access
      Throws:
      FtpException - When random file access isn't supported

    • dispose

      void dispose()
      Dispose file system view.