BaseSftpExecutor (orion-kit 2.0.5 API)

java.lang.Object
- cn.orionsec.kit.net.host.sftp.BaseSftpExecutor

All Implemented Interfaces:

SafeCloseable, ISftpExecutor, Closeable, AutoCloseable

Direct Known Subclasses:

SftpExecutor
```
public abstract class BaseSftpExecutor
extends Object
implements ISftpExecutor
```
sftp 执行器基类

Since:

2022/5/18 15:23

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields
Modifier and Type Field and Description

protected int bufferSize
默认缓冲区大小

protected String charset
编码格式

Fields
Modifier and Type	Field and Description
`protected int`	`bufferSize` 默认缓冲区大小
`protected String`	`charset` 编码格式

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseSftpExecutor()

Constructors
Modifier	Constructor and Description
`protected`	`BaseSftpExecutor()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(String path, byte[] bs, int off, int len)` 拼接文件不存在则报错
`void`	`append(String path, InputStream in)` 拼接流文件不存在则报错
`protected abstract void`	`doAppend(String path, InputStream in, StreamEntry entry)` 执行拼接
`protected void`	`doMakeDir(String path, Consumer<String> creative)` 执行创建文件夹
`protected abstract void`	`doMove(String source, String target)` 移动文件
`protected abstract long`	`doTransfer(String path, OutputStream out, long skip, int size, boolean close)` 执行传输
`void`	`downloadDir(String remoteDir, String localDir, boolean child)` 下载文件夹远程文件夹不存在/是个文件则会报错
`void`	`downloadFile(String remoteFile, OutputStream out, boolean close)` 下载文件远程文件不存在则会报错
`void`	`downloadFile(String remoteFile, String localFile)` 下载文件远程文件不存在则会报错
`protected abstract void`	`doWrite(String path, InputStream in, StreamEntry entry)` 执行写入
`int`	`getBufferSize()` 获取缓冲区大小
`String`	`getCharset()` 获取文件名编码
`protected boolean`	`isSameParentPath(String source, String target)` 检查是否为相同父级目录
`List<SftpFile>`	`listDirs(String path, boolean child)` 文件夹列表文件夹不存在则返回空集合
`List<SftpFile>`	`listFiles(String path, boolean child, boolean dir)` 文件列表文件夹不存在则返回空集合
`List<SftpFile>`	`listFilesFilter(String path, SftpFileFilter filter, boolean child, boolean dir)` 查询文件列表文件夹不存在则返回空集合
`void`	`makeDirectories(String path)` 创建文件夹递归文件夹存在父文件夹不存不会报错路径是文件并且已存在则会报错
`void`	`move(String source, String target)` 移动文件 / 改名原始文件存在则会报错目标文件存在不会报错
`void`	`remove(String path)` 递归删除文件或文件夹文件不存在不会报错
`long`	`transfer(String path, OutputStream out, long skip, int size)` 读取字节到输出流文件不存在则报错
`long`	`transfer(String path, String file, long skip)` 读取文件到本地文件不存在则报错
`void`	`uploadDir(String remoteDir, String localDir, boolean child)` 上传文件夹 /root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root 远程文件夹不存在不会报错远程文件夹是个文件则会报错
`void`	`uploadFile(String remoteFile, InputStream in, boolean close)` 上传文件远程文件存在则会覆盖远程文件是个文件夹则会报错
`void`	`uploadFile(String remoteFile, String localFile)` 上传文件远程文件存在则会覆盖远程文件是个文件夹则会报错
`void`	`write(String path, byte[] bs, int off, int len)` 写入文件不存在则报错
`void`	`write(String path, InputStream in)` 写入流文件不存在则报错

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

Methods inherited from interface cn.orionsec.kit.net.host.sftp.ISftpExecutor
append, append, bufferSize, changeGroup, changeMode, changeOwner, charset, download, download, downloadDir, downloadDir, downloadDir, downloadFile, downloadFile, getFile, getFile, getHome, getLinkPath, getPath, getServerVersion, getSize, hardLink, isConnected, isExist, link, list, listDirs, listFiles, listFiles, listFilesFilter, listFilesFilter, makeDirectory, openInputStream, openInputStream, openOutputStream, openOutputStream, read, read, read, read, removeDir, removeFile, sendSignal, setFileAttribute, setModifyTime, symLink, touch, touch, touchTruncate, transfer, transfer, transfer, transfer, transfer, truncate, upload, upload, uploadDir, uploadDir, uploadDir, uploadFile, uploadFile, write, write

Methods inherited from interface cn.orionsec.kit.lang.able.SafeCloseable
close

- Field Detail
  - charset
```
protected String charset
```
    编码格式
  - bufferSize
```
protected int bufferSize
```
    默认缓冲区大小
- Constructor Detail
  - BaseSftpExecutor
```
protected BaseSftpExecutor()
```
- Method Detail
  - makeDirectories
```
public void makeDirectories(String path)
```
    Description copied from interface: ISftpExecutor
    
    创建文件夹递归
    文件夹存在父文件夹不存不会报错路径是文件并且已存在则会报错
    
    Specified by:
    
    makeDirectories in interface ISftpExecutor
    
    Parameters:
    
    path - 文件夹绝对路径
  - remove
```
public void remove(String path)
```
    Description copied from interface: ISftpExecutor
    
    递归删除文件或文件夹
    文件不存在不会报错
    
    Specified by:
    
    remove in interface ISftpExecutor
    
    Parameters:
    
    path - 路径
  - move
```
public void move(String source,
                 String target)
```
    Description copied from interface: ISftpExecutor
    
    移动文件 / 改名
    原始文件存在则会报错目标文件存在不会报错
    
    Specified by:
    
    move in interface ISftpExecutor
    
    Parameters:
    
    source - 原文件绝对路径
    
    target - 目标文件(绝对路径相对路径) / 文件名称
  - transfer
```
public long transfer(String path,
                     OutputStream out,
                     long skip,
                     int size)
              throws IOException
```
    Description copied from interface: ISftpExecutor
    
    读取字节到输出流
    文件不存在则报错
    
    Specified by:
    
    transfer in interface ISftpExecutor
    
    Parameters:
    
    path - 文件绝对路径
    
    out - 输出流
    
    skip - 跳过字数
    
    size - 读取长度 -1 读取全部
    
    Returns:
    
    已读取长度
    
    Throws:
    
    IOException - IOException
  - transfer
```
public long transfer(String path,
                     String file,
                     long skip)
              throws IOException
```
    Description copied from interface: ISftpExecutor
    
    读取文件到本地
    文件不存在则报错
    
    Specified by:
    
    transfer in interface ISftpExecutor
    
    Parameters:
    
    path - 文件绝对路径
    
    file - 本地文件路径
    
    skip - 跳过字数
    
    Returns:
    
    已读取长度
    
    Throws:
    
    IOException - IOException
  - write
```
public void write(String path,
                  InputStream in)
           throws IOException
```
    Description copied from interface: ISftpExecutor
    
    写入流文件不存在则报错
    
    Specified by:
    
    write in interface ISftpExecutor
    
    Parameters:
    
    path - path
    
    in - in
    
    Throws:
    
    IOException - IOException
  - write
```
public void write(String path,
                  byte[] bs,
                  int off,
                  int len)
           throws IOException
```
    Description copied from interface: ISftpExecutor
    
    写入文件不存在则报错
    
    Specified by:
    
    write in interface ISftpExecutor
    
    Parameters:
    
    path - path
    
    bs - bs
    
    off - off
    
    len - len
    
    Throws:
    
    IOException - IOException
  - append
```
public void append(String path,
                   InputStream in)
            throws IOException
```
    Description copied from interface: ISftpExecutor
    
    拼接流文件不存在则报错
    
    Specified by:
    
    append in interface ISftpExecutor
    
    Parameters:
    
    path - path
    
    in - in
    
    Throws:
    
    IOException - IOException
  - append
```
public void append(String path,
                   byte[] bs,
                   int off,
                   int len)
            throws IOException
```
    Description copied from interface: ISftpExecutor
    
    拼接文件不存在则报错
    
    Specified by:
    
    append in interface ISftpExecutor
    
    Parameters:
    
    path - path
    
    bs - bs
    
    off - off
    
    len - len
    
    Throws:
    
    IOException - IOException
  - uploadFile
```
public void uploadFile(String remoteFile,
                       String localFile)
                throws IOException
```
    Description copied from interface: ISftpExecutor
    
    上传文件
    远程文件存在则会覆盖远程文件是个文件夹则会报错
    
    Specified by:
    
    uploadFile in interface ISftpExecutor
    
    Parameters:
    
    remoteFile - 远程文件
    
    localFile - 本地文件
    
    Throws:
    
    IOException - IOException
  - uploadFile
```
public void uploadFile(String remoteFile,
                       InputStream in,
                       boolean close)
                throws IOException
```
    Description copied from interface: ISftpExecutor
    
    上传文件
    远程文件存在则会覆盖
    远程文件是个文件夹则会报错
    
    Specified by:
    
    uploadFile in interface ISftpExecutor
    
    Parameters:
    
    remoteFile - 远程文件
    
    in - input
    
    close - close
    
    Throws:
    
    IOException - IOException
  - uploadDir
```
public void uploadDir(String remoteDir,
                      String localDir,
                      boolean child)
               throws IOException
```
    Description copied from interface: ISftpExecutor
    
    上传文件夹
    /root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
    远程文件夹不存在不会报错远程文件夹是个文件则会报错
    
    Specified by:
    
    uploadDir in interface ISftpExecutor
    
    Parameters:
    
    remoteDir - 远程文件夹
    
    localDir - 本地文件夹上传时不包含此文件夹
    
    child - 是否遍历上传
    
    Throws:
    
    IOException - IOException
  - downloadFile
```
public void downloadFile(String remoteFile,
                         String localFile)
                  throws IOException
```
    Description copied from interface: ISftpExecutor
    
    下载文件
    远程文件不存在则会报错
    
    Specified by:
    
    downloadFile in interface ISftpExecutor
    
    Parameters:
    
    remoteFile - 远程文件路径
    
    localFile - 本地文件路径
    
    Throws:
    
    IOException - IOException
  - downloadFile
```
public void downloadFile(String remoteFile,
                         OutputStream out,
                         boolean close)
                  throws IOException
```
    Description copied from interface: ISftpExecutor
    
    下载文件
    远程文件不存在则会报错
    
    Specified by:
    
    downloadFile in interface ISftpExecutor
    
    Parameters:
    
    remoteFile - 远程文件路径
    
    out - output
    
    close - 是否自动关闭
    
    Throws:
    
    IOException - IOException
  - downloadDir
```
public void downloadDir(String remoteDir,
                        String localDir,
                        boolean child)
                 throws IOException
```
    Description copied from interface: ISftpExecutor
    
    下载文件夹
    远程文件夹不存在/是个文件则会报错
    
    Specified by:
    
    downloadDir in interface ISftpExecutor
    
    Parameters:
    
    remoteDir - 远程文件夹
    
    localDir - 本地文件夹
    
    child - 是否递归子文件夹下载
    
    Throws:
    
    IOException - IOException
  - listFiles
```
public List<SftpFile> listFiles(String path,
                                boolean child,
                                boolean dir)
```
    Description copied from interface: ISftpExecutor
    
    文件列表
    文件夹不存在则返回空集合
    
    Specified by:
    
    listFiles in interface ISftpExecutor
    
    Parameters:
    
    path - 文件夹绝对路径
    
    child - 是否递归子文件夹
    
    dir - 是否添加文件夹
    
    Returns:
    
    文件列表
  - listDirs
```
public List<SftpFile> listDirs(String path,
                               boolean child)
```
    Description copied from interface: ISftpExecutor
    
    文件夹列表
    文件夹不存在则返回空集合
    
    Specified by:
    
    listDirs in interface ISftpExecutor
    
    Parameters:
    
    path - 文件夹绝对路径
    
    child - 是否递归
    
    Returns:
    
    文件列表
  - listFilesFilter
```
public List<SftpFile> listFilesFilter(String path,
                                      SftpFileFilter filter,
                                      boolean child,
                                      boolean dir)
```
    Description copied from interface: ISftpExecutor
    
    查询文件列表
    文件夹不存在则返回空集合
    
    Specified by:
    
    listFilesFilter in interface ISftpExecutor
    
    Parameters:
    
    path - 文件夹绝对路径
    
    filter - 过滤器
    
    child - 是否递归子文件夹
    
    dir - 是否添加文件夹
    
    Returns:
    
    文件
  - doMove
```
protected abstract void doMove(String source,
                               String target)
```
    移动文件
    
    Parameters:
    
    source - 原文件绝对路径
    
    target - 目标文件绝对路径相对路径都可以
  - doMakeDir
```
protected void doMakeDir(String path,
                         Consumer<String> creative)
```
    执行创建文件夹
    
    Parameters:
    
    path - path
    
    creative - 创建器
  - doTransfer
```
protected abstract long doTransfer(String path,
                                   OutputStream out,
                                   long skip,
                                   int size,
                                   boolean close)
                            throws IOException
```
    执行传输
    
    Parameters:
    
    path - path
    
    out - out
    
    skip - skip
    
    size - size
    
    close - close
    
    Returns:
    
    read
    
    Throws:
    
    IOException - IOException
  - doWrite
```
protected abstract void doWrite(String path,
                                InputStream in,
                                StreamEntry entry)
                         throws IOException
```
    执行写入
    
    Parameters:
    
    path - path
    
    in - in
    
    entry - entry
    
    Throws:
    
    IOException - IOException
  - doAppend
```
protected abstract void doAppend(String path,
                                 InputStream in,
                                 StreamEntry entry)
                          throws IOException
```
    执行拼接
    
    Parameters:
    
    path - path
    
    in - in
    
    entry - entry
    
    Throws:
    
    IOException - IOException
  - isSameParentPath
```
protected boolean isSameParentPath(String source,
                                   String target)
```
    检查是否为相同父级目录
    
    Parameters:
    
    source - source
    
    target - target
    
    Returns:
    
    是否为父级目录
  - getBufferSize
```
public int getBufferSize()
```
    Description copied from interface: ISftpExecutor
    
    获取缓冲区大小
    
    Specified by:
    
    getBufferSize in interface ISftpExecutor
    
    Returns:
    
    bufferSize
  - getCharset
```
public String getCharset()
```
    Description copied from interface: ISftpExecutor
    
    获取文件名编码
    
    Specified by:
    
    getCharset in interface ISftpExecutor
    
    Returns:
    
    文件名编码

Class BaseSftpExecutor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cn.orionsec.kit.net.host.sftp.ISftpExecutor

Methods inherited from interface cn.orionsec.kit.lang.able.SafeCloseable

Field Detail

charset

bufferSize

Constructor Detail

BaseSftpExecutor

Method Detail

makeDirectories

remove

move

transfer

transfer

write

write

append

append

uploadFile

uploadFile

uploadDir

downloadFile

downloadFile

downloadDir

listFiles

listDirs

listFilesFilter

doMove

doMakeDir

doTransfer

doWrite

doAppend

isSameParentPath

getBufferSize

getCharset