Class SFTPClient


  • public class SFTPClient
    extends SFTPv3Client
    This Class adds file manage capabilities to the SFTPv3Client class.
    Author:
    Kohsuke Kawaguchi
    • Constructor Detail

      • SFTPClient

        public SFTPClient​(Connection conn)
                   throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • exists

        public boolean exists​(java.lang.String path)
                       throws java.io.IOException
        Checks if the given path exists.
        Overrides:
        exists in class SFTPv3Client
        Parameters:
        path - directory or file path.
        Returns:
        true if it exists.
        Throws:
        java.io.IOException - if it is not possible to access to the directory or file .
      • _stat

        public SFTPv3FileAttributes _stat​(java.lang.String path)
                                   throws java.io.IOException
        Graceful SFTPv3Client.stat(String) that returns null if the path doesn't exist.
        Overrides:
        _stat in class SFTPv3Client
        Parameters:
        path - directory path.
        Returns:
        the sft pv 3 file attributes
        Throws:
        java.io.IOException - if it is not possible to access to the directory.
      • mkdirs

        public void mkdirs​(java.lang.String path,
                           int posixPermission)
                    throws java.io.IOException
        Makes sure that the directory exists, by creating it if necessary.
        Overrides:
        mkdirs in class SFTPv3Client
        Parameters:
        path - directory path.
        posixPermission - POSIX permissions.
        Throws:
        java.io.IOException - if it is not possible to access to the directory.
      • writeToFile

        public java.io.OutputStream writeToFile​(java.lang.String path)
                                         throws java.io.IOException
        Description copied from class: SFTPv3Client
        Creates a new file and writes to it.
        Overrides:
        writeToFile in class SFTPv3Client
        Parameters:
        path - file path.
        Returns:
        Creates a new file and return an OutputStream to writes to it.
        Throws:
        java.io.IOException - if it is not possible to access to the file.
      • read

        public java.io.InputStream read​(java.lang.String file)
                                 throws java.io.IOException
        Description copied from class: SFTPv3Client
        Read input stream.
        Overrides:
        read in class SFTPv3Client
        Parameters:
        file - file path.
        Returns:
        return an InputStream to the file.
        Throws:
        java.io.IOException - if it is not possible to access to the file.
      • chmod

        public void chmod​(java.lang.String path,
                          int permissions)
                   throws java.io.IOException
        Change file or directory permissions.
        Overrides:
        chmod in class SFTPv3Client
        Parameters:
        path - file or directory path.
        permissions - POSIX permissions.
        Throws:
        java.io.IOException - in case of error.