org.aoju.bus.extra.ssh.Sftp

All Implemented Interfaces:: Closeable, AutoCloseable

public class Sftp extends AbstractFtp

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

Since:: Java 17+
Author:: Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

Sftp.Mode

JSch支持的三种文件传输模式
Field Summary

Fields inherited from class org.aoju.bus.extra.ftp.AbstractFtp
DEFAULT_CHARSET, ftpConfig
Constructor Summary

Constructors

Constructor

Description

Sftp(com.jcraft.jsch.ChannelSftp channel, Charset charset)

构造

Sftp(com.jcraft.jsch.Session session)

构造

Sftp(com.jcraft.jsch.Session session, Charset charset)

构造

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

构造

Sftp(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset)

构造

Sftp(FtpConfig config)

构造

Sftp(FtpConfig config, boolean init)

构造
Method Summary

Modifier and Type

Method

Description

boolean

cd(String directory)

打开指定目录,如果指定路径非目录或不存在返回false

void

close()

boolean

delDir(String dirPath)

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

boolean

delFile(String filePath)

删除文件

void

download(String src, File dest)

下载文件

void

download(String src, OutputStream out)

下载文件到OutputStream中

void

download(String source, String dest)

递归获取远程文件

Sftp

get(String src, OutputStream out)

获取远程文件

Sftp

get(String src, String dest)

获取远程文件

com.jcraft.jsch.ChannelSftp

getClient()

获取SFTP通道客户端

String

home()

获取HOME路径

void

init()

初始化

void

init(com.jcraft.jsch.ChannelSftp channel, Charset charset)

初始化

void

init(com.jcraft.jsch.Session session, Charset charset)

初始化

void

init(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset)

构造

void

init(FtpConfig config)

初始化

boolean

isDir(String dir)

判断给定路径是否为目录

List<String>

ls(String path)

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

List<String>

ls(String path, Predicate<com.jcraft.jsch.ChannelSftp.LsEntry> filter)

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

List<String>

lsDirs(String path)

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

List<String>

lsFiles(String path)

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

boolean

mkdir(String dir)

在当前远程目录(工作目录)下创建新的目录

Sftp

put(InputStream srcStream, String destPath, com.jcraft.jsch.SftpProgressMonitor monitor, Sftp.Mode mode)

将本地数据流上传到目标服务器，目标文件名为destPath，目标必须为文件

Sftp

put(String srcFilePath, String destPath)

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

Sftp

put(String srcFilePath, String destPath, com.jcraft.jsch.SftpProgressMonitor monitor, Sftp.Mode mode)

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

Sftp

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

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

String

pwd()

远程当前目录

Sftp

reconnectIfTimeout()

如果连接超时的话,重新进行连接

void

upload(File file, String remotePath)

将本地文件或者文件夹同步（覆盖）上传到远程路径

boolean

upload(String destPath, File file)

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

boolean

upload(String destPath, String fileName, InputStream fileStream)

上传文件到指定目录，可选：

Methods inherited from class org.aoju.bus.extra.ftp.AbstractFtp
download, exist, mkDirs, toParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Sftp
  
  public Sftp(String sshHost, int sshPort, String sshUser, String sshPass)
  
  构造
  
  Parameters:
  
  sshHost - 远程主机
  
  sshPort - 远程主机端口
  
  sshUser - 远程主机用户名
  
  sshPass - 远程主机密码
- Sftp
  
  public Sftp(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset)
  
  构造
  
  Parameters:
  
  sshHost - 远程主机
  
  sshPort - 远程主机端口
  
  sshUser - 远程主机用户名
  
  sshPass - 远程主机密码
  
  charset - 编码
- Sftp
  
  public Sftp(FtpConfig config)
  
  构造
  
  Parameters:
  
  config - FTP配置
- Sftp
  
  public Sftp(FtpConfig config, boolean init)
  
  构造
  
  Parameters:
  
  config - FTP配置
  
  init - 是否立即初始化
- Sftp
  
  public Sftp(com.jcraft.jsch.Session session)
  
  构造
  
  Parameters:
  
  session - Session
- Sftp
  
  public Sftp(com.jcraft.jsch.Session session, Charset charset)
  
  构造
  
  Parameters:
  
  session - Session
  
  charset - 编码
- Sftp
  
  public Sftp(com.jcraft.jsch.ChannelSftp channel, Charset charset)
  
  构造
  
  Parameters:
  
  channel - ChannelSftp
  
  charset - 编码
Method Details
- init
  
  public void init(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset)
  
  构造
  
  Parameters:
  
  sshHost - 远程主机
  
  sshPort - 远程主机端口
  
  sshUser - 远程主机用户名
  
  sshPass - 远程主机密码
  
  charset - 编码
- init
  
  public void init()
  
  初始化
- init
  
  public void init(FtpConfig config)
  
  初始化
  
  Parameters:
  
  config - FTP配置
- init
  
  public void init(com.jcraft.jsch.Session session, Charset charset)
  
  初始化
  
  Parameters:
  
  session - Session
  
  charset - 编码
- init
  
  public void init(com.jcraft.jsch.ChannelSftp channel, Charset charset)
  
  初始化
  
  Parameters:
  
  channel - ChannelSftp
  
  charset - 编码
- reconnectIfTimeout
  
  public Sftp reconnectIfTimeout()
  
  Description copied from class: AbstractFtp
  
  如果连接超时的话,重新进行连接
  
  Specified by:
  
  reconnectIfTimeout in class AbstractFtp
  
  Returns:
  
  this
- getClient
  
  public com.jcraft.jsch.ChannelSftp getClient()
  
  获取SFTP通道客户端
  
  Returns:
  
  通道客户端
- pwd
  
  public String pwd()
  
  远程当前目录
  
  Specified by:
  
  pwd in class AbstractFtp
  
  Returns:
  
  远程当前目录
- home
  
  public String home()
  
  获取HOME路径
  
  Returns:
  
  HOME路径
- ls
  
  public List<String> ls(String path)
  
  遍历某个目录下所有文件或目录,不会递归遍历
  
  Specified by:
  
  ls in class AbstractFtp
  
  Parameters:
  
  path - 遍历某个目录下所有文件或目录
  
  Returns:
  
  目录或文件名列表
- lsDirs
  
  public List<String> lsDirs(String path)
  
  遍历某个目录下所有目录,不会递归遍历
  
  Parameters:
  
  path - 遍历某个目录下所有目录
  
  Returns:
  
  目录名列表
- lsFiles
  
  public List<String> lsFiles(String path)
  
  遍历某个目录下所有文件,不会递归遍历
  
  Parameters:
  
  path - 遍历某个目录下所有文件
  
  Returns:
  
  文件名列表
- ls
  
  public List<String> ls(String path, Predicate<com.jcraft.jsch.ChannelSftp.LsEntry> filter)
  
  遍历某个目录下所有文件或目录,不会递归遍历
  
  Parameters:
  
  path - 遍历某个目录下所有文件或目录
  
  filter - 文件或目录过滤器,可以实现过滤器返回自己需要的文件或目录名列表
  
  Returns:
  
  目录或文件名列表
- mkdir
  
  public boolean mkdir(String dir)
  
  Description copied from class: AbstractFtp
  
  在当前远程目录(工作目录)下创建新的目录
  
  Specified by:
  
  mkdir in class AbstractFtp
  
  Parameters:
  
  dir - 目录名
  
  Returns:
  
  是否创建成功
- isDir
  
  public boolean isDir(String dir)
  
  Description copied from class: AbstractFtp
  
  判断给定路径是否为目录
  
  Overrides:
  
  isDir in class AbstractFtp
  
  Parameters:
  
  dir - 被判断的路径
  
  Returns:
  
  是否为目录
- cd
  
  public boolean cd(String directory)
  
  打开指定目录,如果指定路径非目录或不存在返回false
  
  Specified by:
  
  cd in class AbstractFtp
  
  Parameters:
  
  directory - directory
  
  Returns:
  
  是否打开目录
- delFile
  
  public boolean delFile(String filePath)
  
  删除文件
  
  Specified by:
  
  delFile in class AbstractFtp
  
  Parameters:
  
  filePath - 要删除的文件绝对路径
  
  Returns:
  
  是否存在
- delDir
  
  public boolean delDir(String dirPath)
  
  删除文件夹及其文件夹下的所有文件
  
  Specified by:
  
  delDir in class AbstractFtp
  
  Parameters:
  
  dirPath - 文件夹路径
  
  Returns:
  
  boolean 是否删除成功
- upload
  
  public boolean upload(String destPath, File file)
  
  Description copied from class: AbstractFtp
  
  将本地文件上传到目标服务器,目标文件名为destPath,若destPath为目录,则目标文件名将与srcFilePath文件名相同覆盖模式
  
  Specified by:
  
  upload in class AbstractFtp
  
  Parameters:
  
  destPath - 本地文件路径
  
  file - 目标文件
  
  Returns:
  
  是否成功
- upload
  
  public void upload(File file, String remotePath)
  
  将本地文件或者文件夹同步（覆盖）上传到远程路径
  
  Parameters:
  
  file - 文件或者文件夹
  
  remotePath - 远程路径
- put
  
  public Sftp put(String srcFilePath, String destPath)
  
  将本地文件上传到目标服务器,目标文件名为destPath,若destPath为目录,则目标文件名将与srcFilePath文件名相同覆盖模式
  
  Parameters:
  
  srcFilePath - 本地文件路径
  
  destPath - 目标路径,
  
  Returns:
  
  this
- put
  
  public Sftp put(String srcFilePath, String destPath, Sftp.Mode mode)
  
  将本地文件上传到目标服务器,目标文件名为destPath,若destPath为目录,则目标文件名将与srcFilePath文件名相同
  
  Parameters:
  
  srcFilePath - 本地文件路径
  
  destPath - 目标路径
  
  mode - Sftp.Mode 模式
  
  Returns:
  
  this
- put
  
  public Sftp put(String srcFilePath, String destPath, com.jcraft.jsch.SftpProgressMonitor monitor, Sftp.Mode mode)
  
  将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。
  
  Parameters:
  
  srcFilePath - 本地文件路径
  
  destPath - 目标路径，
  
  monitor - 上传进度监控，通过实现此接口完成进度显示
  
  mode - Sftp.Mode 模式
  
  Returns:
  
  this
- put
  
  public Sftp put(InputStream srcStream, String destPath, com.jcraft.jsch.SftpProgressMonitor monitor, Sftp.Mode mode)
  
  将本地数据流上传到目标服务器，目标文件名为destPath，目标必须为文件
  
  Parameters:
  
  srcStream - 本地的数据流
  
  destPath - 目标路径，
  
  monitor - 上传进度监控，通过实现此接口完成进度显示
  
  mode - Sftp.Mode 模式
  
  Returns:
  
  this
- download
  
  public void download(String src, File dest)
  
  Description copied from class: AbstractFtp
  
  下载文件
  
  Specified by:
  
  download in class AbstractFtp
  
  Parameters:
  
  src - 文件路径
  
  dest - 输出文件或目录
- download
  
  public void download(String source, String dest)
  
  递归获取远程文件
  
  Specified by:
  
  download in class AbstractFtp
  
  Parameters:
  
  source - 服务器目录
  
  dest - 本地目录
- download
  
  public void download(String src, OutputStream out)
  
  下载文件到OutputStream中
  
  Parameters:
  
  src - 源文件路径，包括文件名
  
  out - 目标流
- upload
  
  public boolean upload(String destPath, String fileName, InputStream fileStream)
  上传文件到指定目录，可选：
  1. path为null或""上传到当前路径 2. path为相对路径则相对于当前路径的子路径 3. path为绝对路径则上传到此路径
  Parameters:
  
  destPath - 服务端路径，可以为null 或者相对路径或绝对路径
  
  fileName - 文件名
  
  fileStream - 文件流
  
  Returns:
  
  是否上传成功
- get
  
  public Sftp get(String src, String dest)
  
  获取远程文件
  
  Parameters:
  
  src - 远程文件路径
  
  dest - 目标文件路径
  
  Returns:
  
  this
- get
  
  public Sftp get(String src, OutputStream out)
  
  获取远程文件
  
  Parameters:
  
  src - 远程文件路径
  
  out - 目标流
  
  Returns:
  
  this
- close
  
  public void close()

Class Sftp

Nested Class Summary

Field Summary

Fields inherited from class org.aoju.bus.extra.ftp.AbstractFtp

Constructor Summary

Method Summary

Methods inherited from class org.aoju.bus.extra.ftp.AbstractFtp

Methods inherited from class java.lang.Object

Constructor Details

Sftp

Sftp

Sftp

Sftp

Sftp

Sftp

Sftp

Method Details

init

init

init

init

init

reconnectIfTimeout

getClient

pwd

home

ls

lsDirs

lsFiles

ls

mkdir

isDir

cd

delFile

delDir

upload

upload

put

put

put

put

download

download

download

upload

get

get

close