Interface FTP

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable
    All Known Implementing Classes:
    FTPS, SFTP

    public interface FTP
    extends java.io.Closeable
    ftp
    simple ftp class
    Since:
    0.2
    Author:
    PARK Yong Seo
    See Also:
    com.jcraft.jsch.JSch
    • Method Summary

      Modifier and Type Method Description
      default boolean cd​(java.lang.String pathname)
      change directory
      same method path(), cd()
      void close()
      close
      boolean delete​(java.lang.String filename)
      remove file
      boolean hasDirectory​(java.lang.String directoryname)
      has directory in path
      boolean hasFile​(java.lang.String filename)
      has file in path
      java.util.List<java.lang.String> listDirectories()
      get directory list in now path
      java.util.List<java.lang.String> listDirectories​(java.util.function.Predicate<java.lang.String> filter)
      get directory list in now path
      java.util.List<java.lang.String> listFiles()
      get file list in now path
      java.util.List<java.lang.String> listFiles​(java.util.function.Predicate<java.lang.String> filter)
      get file list in now path
      boolean mkdir​(java.lang.String createDirectoryName)
      make new directory
      static FTP openFTP​(java.lang.String host, int port, java.lang.String user, java.lang.String pass)
      open ftp
      static FTP openFTP​(java.net.InetAddress host, int port, java.lang.String user, java.lang.String pass)
      open ftp
      static FTP openFTPS​(java.lang.String host, int port, java.lang.String user, java.lang.String pass)
      open ftps
      static FTP openFTPS​(java.net.InetAddress host, int port, java.lang.String user, java.lang.String pass)
      open ftps
      static FTP openSFTP​(java.lang.String host, int port, java.lang.String user, java.lang.String pass)
      open sftp
      java.lang.String path()
      get now path
      same method path(), pwd()
      boolean path​(java.lang.String pathname)
      move path
      same method path(), cd()
      default java.lang.String pwd()
      print working directory
      same method path(), pwd()
      boolean recv​(java.lang.String remoteFilename, java.io.File localFile)
      recv file
      default void recv​(java.util.List<java.lang.String> remoteFilenameList, java.io.File localDirectory)
      recv file list
      default boolean send​(java.io.File localFile)
      send file
      boolean send​(java.lang.String saveFilename, java.io.File localFile)
      send file
    • Method Detail

      • openFTP

        static FTP openFTP​(java.net.InetAddress host,
                           int port,
                           java.lang.String user,
                           java.lang.String pass)
                    throws java.io.IOException
        open ftp
        Parameters:
        host - ip or domain
        port - port (ftp basic port 21)
        user - username
        pass - password
        Returns:
        FTP Object
        Throws:
        java.io.IOException
      • openFTP

        static FTP openFTP​(java.lang.String host,
                           int port,
                           java.lang.String user,
                           java.lang.String pass)
                    throws java.io.IOException
        open ftp
        Parameters:
        host - ip or domain
        port - port (ftp basic port 21)
        user - username
        pass - password
        Returns:
        FTP Object
        Throws:
        java.io.IOException
      • openFTPS

        static FTP openFTPS​(java.net.InetAddress host,
                            int port,
                            java.lang.String user,
                            java.lang.String pass)
                     throws java.io.IOException
        open ftps
        Parameters:
        host - ip or domain
        port - port (ftps basic port 990)
        user - username
        pass - password
        Returns:
        FTP Object
        Throws:
        java.io.IOException
      • openFTPS

        static FTP openFTPS​(java.lang.String host,
                            int port,
                            java.lang.String user,
                            java.lang.String pass)
                     throws java.io.IOException
        open ftps
        Parameters:
        host - ip or domain
        port - port (ftps basic port 990)
        user - username
        pass - password
        Returns:
        FTP Object
        Throws:
        java.io.IOException
      • openSFTP

        static FTP openSFTP​(java.lang.String host,
                            int port,
                            java.lang.String user,
                            java.lang.String pass)
                     throws java.io.IOException
        open sftp
        Parameters:
        host - ip or domain
        port - port (sftp basic port 22)
        user - username
        pass - password
        Returns:
        FTP Object
        Throws:
        java.io.IOException
      • cd

        default boolean cd​(java.lang.String pathname)
                    throws java.io.IOException
        change directory
        same method path(), cd()
        Returns:
        Throws:
        java.io.IOException
      • path

        boolean path​(java.lang.String pathname)
              throws java.io.IOException
        move path
        same method path(), cd()
        Parameters:
        path -
        Returns:
        Throws:
        java.io.IOException
      • path

        java.lang.String path()
                       throws java.io.IOException
        get now path
        same method path(), pwd()
        Returns:
        Throws:
        java.io.IOException
      • pwd

        default java.lang.String pwd()
                              throws java.io.IOException
        print working directory
        same method path(), pwd()
        Returns:
        Throws:
        java.io.IOException
      • listFiles

        java.util.List<java.lang.String> listFiles​(java.util.function.Predicate<java.lang.String> filter)
                                            throws java.io.IOException
        get file list in now path
        Parameters:
        filter - file name filter
        Returns:
        Throws:
        java.io.IOException
      • listFiles

        java.util.List<java.lang.String> listFiles()
                                            throws java.io.IOException
        get file list in now path
        Returns:
        Throws:
        java.io.IOException
      • listDirectories

        java.util.List<java.lang.String> listDirectories​(java.util.function.Predicate<java.lang.String> filter)
                                                  throws java.io.IOException
        get directory list in now path
        Parameters:
        filter - file name filter
        Returns:
        Throws:
        java.io.IOException
      • listDirectories

        java.util.List<java.lang.String> listDirectories()
                                                  throws java.io.IOException
        get directory list in now path
        Returns:
        Throws:
        java.io.IOException
      • hasFile

        boolean hasFile​(java.lang.String filename)
                 throws java.io.IOException
        has file in path
        Parameters:
        filename -
        Returns:
        Throws:
        java.io.IOException
      • hasDirectory

        boolean hasDirectory​(java.lang.String directoryname)
                      throws java.io.IOException
        has directory in path
        Parameters:
        directoryname -
        Returns:
        Throws:
        java.io.IOException
      • delete

        boolean delete​(java.lang.String filename)
                throws java.io.IOException
        remove file
        Parameters:
        file -
        Returns:
        Throws:
        java.io.IOException
      • send

        boolean send​(java.lang.String saveFilename,
                     java.io.File localFile)
              throws java.io.IOException
        send file
        Parameters:
        saveFilename -
        localFile -
        Returns:
        Throws:
        java.io.IOException
      • send

        default boolean send​(java.io.File localFile)
                      throws java.io.IOException
        send file
        Parameters:
        localFile -
        Returns:
        Throws:
        java.io.IOException
      • recv

        boolean recv​(java.lang.String remoteFilename,
                     java.io.File localFile)
              throws java.io.IOException
        recv file
        Parameters:
        serverFileName -
        localFile -
        Returns:
        Throws:
        java.io.IOException
      • recv

        default void recv​(java.util.List<java.lang.String> remoteFilenameList,
                          java.io.File localDirectory)
                   throws java.io.IOException
        recv file list
        Parameters:
        remoteFilenameList -
        localDirectory -
        Throws:
        java.io.IOException
      • mkdir

        boolean mkdir​(java.lang.String createDirectoryName)
               throws java.io.IOException
        make new directory
        Parameters:
        createDirectoryName -
        Returns:
        Throws:
        java.io.IOException
      • close

        void close()
        close
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable