SshjSftp (hutool-extra 6.0.0-M5 API)

java.lang.Object
- org.dromara.hutool.extra.ftp.AbstractFtp
- - org.dromara.hutool.extra.ssh.SshjSftp

所有已实现的接口:

Closeable, AutoCloseable
```
public class SshjSftp
extends AbstractFtp
```
在使用jsch 进行sftp协议下载文件时，总是中文乱码，而该框架源码又不允许设置编码。故：站在巨人的肩膀上，此类便孕育而出。
基于sshj 框架适配。
参考：https://github.com/hierynomus/sshj

作者:

youyongkun

从以下版本开始:

5.7.19

字段概要
- 从类继承的字段 org.dromara.hutool.extra.ftp.AbstractFtp
  DEFAULT_CHARSET, ftpConfig

构造器概要

构造器
限定符	构造器和说明
`protected`	`SshjSftp(FtpConfig config)` 构造
	`SshjSftp(String sshHost)` 构造，使用默认端口
	`SshjSftp(String sshHost, int sshPort, String sshUser, String sshPass)` 构造
	`SshjSftp(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset)` 构造
	`SshjSftp(String sshHost, String sshUser, String sshPass)` 构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`cd(String directory)` 打开指定目录，具体逻辑取决于实现，例如在FTP中，进入失败返回`false`， SFTP中则抛出异常
`void`	`close()`
`String`	`command(String exec)` 执行Linux 命令
`boolean`	`containsFile(String fileDir)` 是否包含该文件
`boolean`	`delDir(String dirPath)` 删除文件夹及其文件夹下的所有文件
`boolean`	`delFile(String path)` 删除指定目录下的指定文件
`void`	`download(String path, File outFile)` 下载文件
`void`	`init()` SSH 初始化并创建一个sftp客户端.
`List<String>`	`ls(String path)` 遍历某个目录下所有文件和目录，不会递归遍历
`boolean`	`mkdir(String dir)` 在当前远程目录（工作目录）下创建新的目录
`String`	`pwd()` 远程当前目录（工作目录）
`AbstractFtp`	`reconnectIfTimeout()` 如果连接超时的话，重新进行连接
`void`	`recursiveDownloadFolder(String sourcePath, File destDir)` 递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
`boolean`	`uploadFile(String destPath, File file)` 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。

从类继承的方法 org.dromara.hutool.extra.ftp.AbstractFtp
download, exist, isDir, mkDirs, toParent

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SshjSftp
```
public SshjSftp(String sshHost)
```
    构造，使用默认端口
    
    参数:
    
    sshHost - 主机
  - SshjSftp
```
public SshjSftp(String sshHost,
                String sshUser,
                String sshPass)
```
    构造
    
    参数:
    
    sshHost - 主机
    
    sshUser - 用户名
    
    sshPass - 密码
  - SshjSftp
```
public SshjSftp(String sshHost,
                int sshPort,
                String sshUser,
                String sshPass)
```
    构造
    
    参数:
    
    sshHost - 主机
    
    sshPort - 端口
    
    sshUser - 用户名
    
    sshPass - 密码
  - SshjSftp
```
public SshjSftp(String sshHost,
                int sshPort,
                String sshUser,
                String sshPass,
                Charset charset)
```
    构造
    
    参数:
    
    sshHost - 主机
    
    sshPort - 端口
    
    sshUser - 用户名
    
    sshPass - 密码
    
    charset - 编码
  - SshjSftp
```
protected SshjSftp(FtpConfig config)
```
    构造
    
    参数:
    
    config - FTP配置
    
    从以下版本开始:
    
    5.3.3
- 方法详细资料
  - init
```
public void init()
```
    SSH 初始化并创建一个sftp客户端.
    
    从以下版本开始:
    
    5.7.18
  - reconnectIfTimeout
```
public AbstractFtp reconnectIfTimeout()
```
    从类复制的说明: AbstractFtp
    
    如果连接超时的话，重新进行连接
    
    指定者:
    
    reconnectIfTimeout 在类中 AbstractFtp
    
    返回:
    
    this
  - cd
```
public boolean cd(String directory)
```
    从类复制的说明: AbstractFtp
    
    打开指定目录，具体逻辑取决于实现，例如在FTP中，进入失败返回false， SFTP中则抛出异常
    
    指定者:
    
    cd 在类中 AbstractFtp
    
    参数:
    
    directory - directory
    
    返回:
    
    是否打开目录
  - pwd
```
public String pwd()
```
    从类复制的说明: AbstractFtp
    
    远程当前目录（工作目录）
    
    指定者:
    
    pwd 在类中 AbstractFtp
    
    返回:
    
    远程当前目录
  - mkdir
```
public boolean mkdir(String dir)
```
    从类复制的说明: AbstractFtp
    
    在当前远程目录（工作目录）下创建新的目录
    
    指定者:
    
    mkdir 在类中 AbstractFtp
    
    参数:
    
    dir - 目录名
    
    返回:
    
    是否创建成功
  - ls
```
public List<String> ls(String path)
```
    从类复制的说明: AbstractFtp
    
    遍历某个目录下所有文件和目录，不会递归遍历
    
    指定者:
    
    ls 在类中 AbstractFtp
    
    参数:
    
    path - 需要遍历的目录
    
    返回:
    
    文件和目录列表
  - delFile
```
public boolean delFile(String path)
```
    从类复制的说明: AbstractFtp
    
    删除指定目录下的指定文件
    
    指定者:
    
    delFile 在类中 AbstractFtp
    
    参数:
    
    path - 目录路径
    
    返回:
    
    是否存在
  - delDir
```
public boolean delDir(String dirPath)
```
    从类复制的说明: AbstractFtp
    
    删除文件夹及其文件夹下的所有文件
    
    指定者:
    
    delDir 在类中 AbstractFtp
    
    参数:
    
    dirPath - 文件夹路径
    
    返回:
    
    boolean 是否删除成功
  - uploadFile
```
public boolean uploadFile(String destPath,
                          File file)
```
    从类复制的说明: AbstractFtp
    
    将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。覆盖模式
    
    指定者:
    
    uploadFile 在类中 AbstractFtp
    
    参数:
    
    destPath - 服务端路径，可以为null 或者相对路径或绝对路径
    
    file - 需要上传的文件
    
    返回:
    
    是否成功
  - download
```
public void download(String path,
                     File outFile)
```
    从类复制的说明: AbstractFtp
    
    下载文件
    
    指定者:
    
    download 在类中 AbstractFtp
    
    参数:
    
    path - 文件路径
    
    outFile - 输出文件或目录
  - recursiveDownloadFolder
```
public void recursiveDownloadFolder(String sourcePath,
                                    File destDir)
```
    从类复制的说明: AbstractFtp
    
    递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
    
    指定者:
    
    recursiveDownloadFolder 在类中 AbstractFtp
    
    参数:
    
    sourcePath - ftp服务器目录
    
    destDir - 本地目录
  - close
```
public void close()
```
  - containsFile
```
public boolean containsFile(String fileDir)
```
    是否包含该文件
    
    参数:
    
    fileDir - 文件绝对路径
    
    返回:
    
    true:包含 false:不包含
    
    从以下版本开始:
    
    5.7.18
  - command
```
public String command(String exec)
```
    执行Linux 命令
    
    参数:
    
    exec - 命令
    
    返回:
    
    返回响应结果.
    
    从以下版本开始:
    
    5.7.19

类 SshjSftp

字段概要

从类继承的字段 org.dromara.hutool.extra.ftp.AbstractFtp

构造器概要

方法概要

从类继承的方法 org.dromara.hutool.extra.ftp.AbstractFtp

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

构造器详细资料

SshjSftp

SshjSftp

SshjSftp

SshjSftp

SshjSftp

方法详细资料

init

reconnectIfTimeout

cd

pwd

mkdir

ls

delFile

delDir

uploadFile

download

recursiveDownloadFolder

close

containsFile

command