cn.hutool.extra.ssh

类 Sftp

java.lang.Object

cn.hutool.extra.ssh.Sftp

所有已实现的接口:

Closeable, AutoCloseable

public class Sftp
extends Object
implements Closeable

SFTP是Secure File Transfer Protocol的缩写，安全文件传送协议。可以为传输文件提供一种安全的加密方法。
SFTP 为 SSH的一部份，是一种传输文件到服务器的安全方式。SFTP是使用加密传输认证信息和传输的数据，所以，使用SFTP是非常安全的。
但是，由于这种传输方式使用了加密/解密技术，所以传输效率比普通的FTP要低得多，如果您对网络安全性要求更高时，可以使用SFTP代替FTP。

此类为基于jsch的SFTP实现
参考：https://www.cnblogs.com/longyg/archive/2012/06/25/2556576.html

从以下版本开始:

4.0.2

作者:

looly

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Sftp.Mode JSch支持的三种文件传输模式

构造器概要

构造器

构造器和说明
Sftp(com.jcraft.jsch.ChannelSftp channel) 构造
Sftp(com.jcraft.jsch.Session session) 构造
Sftp(String sshHost, int sshPort, String sshUser, String sshPass) 构造

方法概要

方法

限定符和类型	方法和说明
boolean	cd(String directory) 打开指定目录
void	close()
boolean	delDir(String dirPath) 删除文件夹及其文件夹下的所有文件
Sftp	delFile(String filePath) 删除文件
boolean	exist(String path, String fileOrDirName) 文件或目录在指定目录下是否存在
Sftp	get(String src, String dest) 获取远程文件
com.jcraft.jsch.ChannelSftp	getChannel() 获取SFTP通道
String	home() 获取HOME路径
List<String>	ls(String path) 遍历某个目录下所有文件或目录，不会递归遍历
List<String>	ls(String path, Filter<com.jcraft.jsch.ChannelSftp.LsEntry> filter) 遍历某个目录下所有文件或目录，不会递归遍历
List<String>	lsDirs(String path) 遍历某个目录下所有目录，不会递归遍历
List<String>	lsFiles(String path) 遍历某个目录下所有文件，不会递归遍历
void	mkDirs(String dir) 创建指定文件夹及其父目录
Sftp	put(String srcFilePath, String destPath) 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。
Sftp	put(String srcFilePath, String destPath, Sftp.Mode mode) 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。
String	pwd() 远程当前目录
boolean	toParent() 打开上级目录

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Sftp

public Sftp(String sshHost,
    int sshPort,
    String sshUser,
    String sshPass)

构造

参数:

sshHost - 远程主机

sshPort - 远程主机端口

sshUser - 远程主机用户名

sshPass - 远程主机密码

Sftp

public Sftp(com.jcraft.jsch.Session session)

构造

参数:

session - Session

Sftp

public Sftp(com.jcraft.jsch.ChannelSftp channel)

构造

参数:

channel - ChannelSftp

方法详细资料

getChannel

public com.jcraft.jsch.ChannelSftp getChannel()

获取SFTP通道

返回:

通道

pwd

public String pwd()

远程当前目录

返回:

远程当前目录

home

public String home()

获取HOME路径

返回:

HOME路径

从以下版本开始:

4.0.5

exist

public boolean exist(String path,
            String fileOrDirName)

文件或目录在指定目录下是否存在

参数:

path - 目录

fileOrDirName - 文件或目录名

返回:

是否存在

从以下版本开始:

4.0.5

ls

public List<String> ls(String path)

遍历某个目录下所有文件或目录，不会递归遍历

参数:

path - 遍历某个目录下所有文件或目录

返回:

目录或文件名列表

从以下版本开始:

4.0.5

lsDirs

public List<String> lsDirs(String path)

遍历某个目录下所有目录，不会递归遍历

参数:

path - 遍历某个目录下所有目录

返回:

目录名列表

从以下版本开始:

4.0.5

lsFiles

public List<String> lsFiles(String path)

遍历某个目录下所有文件，不会递归遍历

参数:

path - 遍历某个目录下所有文件

返回:

文件名列表

从以下版本开始:

4.0.5

ls

public List<String> ls(String path,
              Filter<com.jcraft.jsch.ChannelSftp.LsEntry> filter)

遍历某个目录下所有文件或目录，不会递归遍历

参数:

path - 遍历某个目录下所有文件或目录

filter - 文件或目录过滤器，可以实现过滤器返回自己需要的文件或目录名列表

返回:

目录或文件名列表

从以下版本开始:

4.0.5

toParent

public boolean toParent()

打开上级目录

返回:

是否打开目录

从以下版本开始:

4.0.5

cd

public boolean cd(String directory)

打开指定目录

参数:

directory - directory

返回:

是否打开目录

mkDirs

public void mkDirs(String dir)

创建指定文件夹及其父目录

参数:

dir - 文件夹路径，绝对路径

delFile

public Sftp delFile(String filePath)

删除文件

参数:

filePath - 要删除的文件绝对路径

delDir

public boolean delDir(String dirPath)

删除文件夹及其文件夹下的所有文件

参数:

dirPath - 文件夹路径

返回:

boolean 是否删除成功

put

public Sftp put(String srcFilePath,
       String destPath)

将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。覆盖模式

参数:

srcFilePath - 本地文件路径

destPath - 目标路径，

返回:

this

put

public Sftp put(String srcFilePath,
       String destPath,
       Sftp.Mode mode)

将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。

参数:

srcFilePath - 本地文件路径

destPath - 目标路径，

mode - Sftp.Mode 模式

返回:

this

get

public Sftp get(String src,
       String dest)

获取远程文件

参数:

src - 远程文件路径

dest - 目标文件路径

返回:

this

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException