cn.orionsec.kit.net.host.sftp

Class SftpExecutor

java.lang.Object

cn.orionsec.kit.net.host.sftp.BaseSftpExecutor

cn.orionsec.kit.net.host.sftp.SftpExecutor

All Implemented Interfaces:

SafeCloseable, HostConnector, ISftpExecutor, Closeable, AutoCloseable

public class SftpExecutor
extends BaseSftpExecutor
implements HostConnector

sftp 执行器

文件路必须是绝对路径 可以包含 ../ ./

Since:

2022/5/18 15:22

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields inherited from class cn.orionsec.kit.net.host.sftp.BaseSftpExecutor

bufferSize, charset

Constructor Summary

Constructors

Constructor and Description
SftpExecutor(com.jcraft.jsch.ChannelSftp channel)
SftpExecutor(com.jcraft.jsch.ChannelSftp channel, String charset)

Method Summary

Modifier and Type	Method and Description
void	bufferSize(int bufferSize) 设置缓冲区大小
void	changeGroup(String file, int gid) 修改文件所有组 文件不存在则会报错
void	changeMode(String file, int permission) 修改文件权限 文件不存在则会报错
void	changeOwner(String file, int uid) 修改文件所有人 文件不存在则会报错
void	charset(String charset) 设置文件名称编码格式
void	close() 安全关闭
void	connect() 建立连接
void	connect(int timeout) 建立连接 使用此方法可能会导致连接不上 但是还不会抛出异常!
protected void	doAppend(String path, InputStream in, StreamEntry entry) 执行拼接
protected void	doMove(String source, String target) 移动文件
protected long	doTransfer(String path, OutputStream out, long skip, int size, boolean close) 执行传输
SftpDownloader	download(String remote, File local) 获取文件上传器
SftpDownloader	download(String remote, String local) 获取文件下载器
protected void	doWrite(String path, InputStream in, StreamEntry entry) 执行写入
com.jcraft.jsch.ChannelSftp	getChannel() 获取 channel
SftpFile	getFile(String path) 获取文件属性 文件不存在返回 null
SftpFile	getFile(String path, boolean followSymbolic) 获取文件属性 文件不存在返回 null
String	getHome() 获取根目录
String	getLinkPath(String path) 获取连接文件的源文件 文件不存在 不会报错 不是连接文件 不会报错
String	getPath(String path) 获取文件规范路径 文件不存在返回null
int	getServerVersion() 获取服务端版本
long	getSize(String path) 获取文件大小 如果不存在返回 -1
void	hardLink(String source, String target) 创建硬连接 原始文件不存在 则会报错 连接文件存在 则会报错
boolean	isConnected() 检查 channel 是否已连接
boolean	isExist(String path) 检查文件是否存在 文件不存在不会报错
void	link(String source, String target, boolean hard) 创建连接文件 原始文件不存在 则会报错 连接文件存在 则会报错
List<SftpFile>	list(String path) 获取目录文件属性 文件夹不存在则返回空
void	makeDirectory(String path) 创建文件夹 文件夹存在 路径是文件并且已存在 父文件夹不存 则会报错
InputStream	openInputStream(String path, long skip) 打开存在文件的输入流 文件不存在会报错
OutputStream	openOutputStream(String path, boolean append) 打开存在文件的输出流 文件不存在会创建
OutputStream	openOutputStream(String path, int mode) 打开存在文件的输出流
int	read(String path, long skip, byte[] bs, int offset, int len) 读取文件 文件不存在则报错
void	removeDir(String path) 删除一个空的文件夹 文件夹不存在 不会报错 删除的是文件 不会报错 不会删除 不是空文件夹 会报错
void	removeFile(String path) 删除一个普通文件 文件不存在 不会报错 删除的是文件夹 会报错
void	sendSignal(String signal) 发送信号量
void	setFileAttribute(SftpFile attribute) 设置文件属性 文件不存在则会报错
void	setModifyTime(String path, Date date) 设置文件修改时间 文件不存在则会报错
void	symLink(String source, String target) 创建软连接文件 原始文件不存在 则会报错 连接文件存在 则会报错
void	touch(String path) 创建文件 文件是与存在的文件夹则会报错
void	touch(String path, boolean truncate) 创建文件 文件是与存在的文件夹则会报错
void	touchTruncate(String path) 创建文件 如果文件存在则截断 文件是与存在的文件夹则会报错
void	truncate(String path) 清空文件, 没有则创建 文件是与存在的文件夹则会报错
SftpUploader	upload(String remote, File local) 获取文件上传器
SftpUploader	upload(String remote, String local) 获取文件上传器

Methods inherited from class cn.orionsec.kit.net.host.sftp.BaseSftpExecutor

append, append, doMakeDir, downloadDir, downloadFile, downloadFile, getBufferSize, getCharset, isSameParentPath, listDirs, listFiles, listFilesFilter, makeDirectories, move, remove, transfer, transfer, uploadDir, uploadFile, uploadFile, write, write

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.HostConnector

disconnect, disconnectChannel, disconnectSession, getSession, isClosed, isEof

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

append, append, downloadDir, downloadDir, downloadDir, downloadFile, downloadFile, listDirs, listFiles, listFiles, listFilesFilter, listFilesFilter, openInputStream, openOutputStream, read, read, read, transfer, transfer, transfer, transfer, transfer, uploadDir, uploadDir, uploadDir, uploadFile, uploadFile, write, write

Constructor Detail

SftpExecutor

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

SftpExecutor

public SftpExecutor(com.jcraft.jsch.ChannelSftp channel,
                    String charset)

Method Detail

bufferSize

public void bufferSize(int bufferSize)

Description copied from interface: ISftpExecutor

设置缓冲区大小

Specified by:

bufferSize in interface ISftpExecutor

Parameters:

bufferSize - 缓冲区大小

charset

public void charset(String charset)

Description copied from interface: ISftpExecutor

设置文件名称编码格式

Specified by:

charset in interface ISftpExecutor

Parameters:

charset - 编码格式

sendSignal

public void sendSignal(String signal)

Description copied from interface: ISftpExecutor

发送信号量

Specified by:

sendSignal in interface ISftpExecutor

Parameters:

signal - 信号

getHome

public String getHome()

Description copied from interface: ISftpExecutor

获取根目录

Specified by:

getHome in interface ISftpExecutor

Returns:

根目录

isExist

public boolean isExist(String path)

Description copied from interface: ISftpExecutor

检查文件是否存在

文件不存在不会报错

Specified by:

isExist in interface ISftpExecutor

Parameters:

path - 文件绝对路径

Returns:

true 存在

getPath

public String getPath(String path)

Description copied from interface: ISftpExecutor

获取文件规范路径

文件不存在返回null

Specified by:

getPath in interface ISftpExecutor

Parameters:

path - 文件路径

Returns:

文件绝对路径

getLinkPath

public String getLinkPath(String path)

Description copied from interface: ISftpExecutor

获取连接文件的源文件

文件不存在 不会报错 不是连接文件 不会报错

Specified by:

getLinkPath in interface ISftpExecutor

Parameters:

path - 连接文件的绝对路径

Returns:

源文件的路径 null文件不是连接文件

getFile

public SftpFile getFile(String path)

Description copied from interface: ISftpExecutor

获取文件属性

文件不存在返回 null

Specified by:

getFile in interface ISftpExecutor

Parameters:

path - 文件绝对路径

Returns:

属性

getFile

public SftpFile getFile(String path,
                        boolean followSymbolic)

Description copied from interface: ISftpExecutor

获取文件属性

文件不存在返回 null

Specified by:

getFile in interface ISftpExecutor

Parameters:

path - 文件绝对路径

followSymbolic - 如果是连接文件是否返回原文件属性

Returns:

属性

getSize

public long getSize(String path)

Description copied from interface: ISftpExecutor

获取文件大小

如果不存在返回 -1

Specified by:

getSize in interface ISftpExecutor

Parameters:

path - 文件绝对路径

Returns:

文件大小

setFileAttribute

public void setFileAttribute(SftpFile attribute)

Description copied from interface: ISftpExecutor

设置文件属性

文件不存在则会报错

Specified by:

setFileAttribute in interface ISftpExecutor

Parameters:

attribute - 文件属性

setModifyTime

public void setModifyTime(String path,
                          Date date)

Description copied from interface: ISftpExecutor

设置文件修改时间

文件不存在则会报错

Specified by:

setModifyTime in interface ISftpExecutor

Parameters:

path - 文件绝对路径

date - 修改时间

changeMode

public void changeMode(String file,
                       int permission)

Description copied from interface: ISftpExecutor

修改文件权限

文件不存在则会报错

Specified by:

changeMode in interface ISftpExecutor

Parameters:

file - 文件绝对路径

permission - 10进制表示的 8进制权限 如: 777

changeOwner

public void changeOwner(String file,
                        int uid)

Description copied from interface: ISftpExecutor

修改文件所有人

文件不存在则会报错

Specified by:

changeOwner in interface ISftpExecutor

Parameters:

file - 文件绝对路径

uid - 用户id

changeGroup

public void changeGroup(String file,
                        int gid)

Description copied from interface: ISftpExecutor

修改文件所有组

文件不存在则会报错

Specified by:

changeGroup in interface ISftpExecutor

Parameters:

file - 文件绝对路径

gid - 组id

makeDirectory

public void makeDirectory(String path)

Description copied from interface: ISftpExecutor

创建文件夹

文件夹存在 路径是文件并且已存在 父文件夹不存 则会报错

Specified by:

makeDirectory in interface ISftpExecutor

Parameters:

path - 文件夹绝对路径

removeDir

public void removeDir(String path)

Description copied from interface: ISftpExecutor

删除一个空的文件夹

文件夹不存在 不会报错 删除的是文件 不会报错 不会删除 不是空文件夹 会报错

Specified by:

removeDir in interface ISftpExecutor

Parameters:

path - 绝对路径

removeFile

public void removeFile(String path)

Description copied from interface: ISftpExecutor

删除一个普通文件

文件不存在 不会报错 删除的是文件夹 会报错

Specified by:

removeFile in interface ISftpExecutor

Parameters:

path - 绝对路径

touch

public void touch(String path)

Description copied from interface: ISftpExecutor

创建文件

文件是与存在的文件夹则会报错

Specified by:

touch in interface ISftpExecutor

Parameters:

path - 文件绝对路径

touchTruncate

public void touchTruncate(String path)

Description copied from interface: ISftpExecutor

创建文件 如果文件存在则截断

文件是与存在的文件夹则会报错

Specified by:

touchTruncate in interface ISftpExecutor

Parameters:

path - 文件绝对路径

touch

public void touch(String path,
                  boolean truncate)

Description copied from interface: ISftpExecutor

创建文件

文件是与存在的文件夹则会报错

Specified by:

touch in interface ISftpExecutor

Parameters:

path - 文件绝对路径

truncate - 如果文件存在是否截断

truncate

public void truncate(String path)

Description copied from interface: ISftpExecutor

清空文件, 没有则创建

文件是与存在的文件夹则会报错

Specified by:

truncate in interface ISftpExecutor

Parameters:

path - 文件绝对路径

hardLink

public void hardLink(String source,
                     String target)

Description copied from interface: ISftpExecutor

创建硬连接

原始文件不存在 则会报错 连接文件存在 则会报错

Specified by:

hardLink in interface ISftpExecutor

Parameters:

source - source

target - target

symLink

public void symLink(String source,
                    String target)

Description copied from interface: ISftpExecutor

创建软连接文件

原始文件不存在 则会报错 连接文件存在 则会报错

Specified by:

symLink in interface ISftpExecutor

Parameters:

source - source

target - target

link

public void link(String source,
                 String target,
                 boolean hard)

Description copied from interface: ISftpExecutor

创建连接文件

原始文件不存在 则会报错 连接文件存在 则会报错

Specified by:

link in interface ISftpExecutor

Parameters:

source - source

target - target

hard - 是否为硬链接

doMove

protected void doMove(String source,
                      String target)

Description copied from class: BaseSftpExecutor

移动文件

Specified by:

doMove in class BaseSftpExecutor

Parameters:

source - 原文件绝对路径

target - 目标文件 绝对路径 相对路径都可以

openInputStream

public InputStream openInputStream(String path,
                                   long skip)
                            throws IOException

Description copied from interface: ISftpExecutor

打开存在文件的输入流

文件不存在会报错

Specified by:

openInputStream in interface ISftpExecutor

Parameters:

path - 文件路径

skip - 跳过的字节

Returns:

InputStream

Throws:

IOException - IOException

openOutputStream

public OutputStream openOutputStream(String path,
                                     boolean append)
                              throws IOException

Description copied from interface: ISftpExecutor

打开存在文件的输出流

文件不存在会创建

Specified by:

openOutputStream in interface ISftpExecutor

Parameters:

path - 文件路径

append - 是否为拼接

Returns:

OutputStream

Throws:

IOException - IOException

openOutputStream

public OutputStream openOutputStream(String path,
                                     int mode)
                              throws IOException

打开存在文件的输出流

Parameters:

path - 文件路径

mode - 0 完全覆盖模式 1 恢复模式 2 追加模式

Returns:

OutputStream

Throws:

IOException - IOException

read

public int read(String path,
                long skip,
                byte[] bs,
                int offset,
                int len)
         throws IOException

Description copied from interface: ISftpExecutor

读取文件

文件不存在则报错

Specified by:

read in interface ISftpExecutor

Parameters:

path - 文件绝对路径

skip - 跳过字节数

bs - 字节数组

offset - offset

len - len

Returns:

read len

Throws:

IOException - IOException

doTransfer

protected long doTransfer(String path,
                          OutputStream out,
                          long skip,
                          int size,
                          boolean close)
                   throws IOException

Description copied from class: BaseSftpExecutor

执行传输

Specified by:

doTransfer in class BaseSftpExecutor

Parameters:

path - path

out - out

skip - skip

size - size

close - close

Returns:

read

Throws:

IOException - IOException

doWrite

protected void doWrite(String path,
                       InputStream in,
                       StreamEntry entry)
                throws IOException

Description copied from class: BaseSftpExecutor

执行写入

Specified by:

doWrite in class BaseSftpExecutor

Parameters:

path - path

in - in

entry - entry

Throws:

IOException - IOException

doAppend

protected void doAppend(String path,
                        InputStream in,
                        StreamEntry entry)
                 throws IOException

Description copied from class: BaseSftpExecutor

执行拼接

Specified by:

doAppend in class BaseSftpExecutor

Parameters:

path - path

in - in

entry - entry

Throws:

IOException - IOException

upload

public SftpUploader upload(String remote,
                           File local)

Description copied from interface: ISftpExecutor

获取文件上传器

Specified by:

upload in interface ISftpExecutor

Parameters:

remote - 远程文件绝对路径

local - 本地文件

Returns:

文件上传器

upload

public SftpUploader upload(String remote,
                           String local)

Description copied from interface: ISftpExecutor

获取文件上传器

Specified by:

upload in interface ISftpExecutor

Parameters:

remote - 远程文件绝对路径

local - 本地文件

Returns:

文件上传器

download

public SftpDownloader download(String remote,
                               File local)

Description copied from interface: ISftpExecutor

获取文件上传器

Specified by:

download in interface ISftpExecutor

Parameters:

remote - 远程文件绝对路径

local - 本地文件

Returns:

文件上传器

download

public SftpDownloader download(String remote,
                               String local)

Description copied from interface: ISftpExecutor

获取文件下载器

Specified by:

download in interface ISftpExecutor

Parameters:

remote - 远程文件绝对路径

local - 本地文件

Returns:

文件下载器

list

public List<SftpFile> list(String path)

Description copied from interface: ISftpExecutor

获取目录文件属性

文件夹不存在则返回空

Specified by:

list in interface ISftpExecutor

Parameters:

path - 文件绝对路径

Returns:

属性

connect

public void connect()

Description copied from interface: HostConnector

建立连接

Specified by:

connect in interface HostConnector

connect

public void connect(int timeout)

Description copied from interface: HostConnector

建立连接 使用此方法可能会导致连接不上 但是还不会抛出异常! 即 isConnected() 返回 false 因为设置了超时时间 会将 Channel.sendChannelOpen() 的 retry 设置为 1

Specified by:

connect in interface HostConnector

Parameters:

timeout - 超时时间 ms

isConnected

public boolean isConnected()

Description copied from interface: HostConnector

检查 channel 是否已连接

Specified by:

isConnected in interface HostConnector

Specified by:

isConnected in interface ISftpExecutor

Returns:

是否已连接

getServerVersion

public int getServerVersion()

Description copied from interface: ISftpExecutor

获取服务端版本

Specified by:

getServerVersion in interface ISftpExecutor

Returns:

服务端版本

close

public void close()

Description copied from interface: SafeCloseable

安全关闭

Specified by:

close in interface SafeCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getChannel

public com.jcraft.jsch.ChannelSftp getChannel()

Description copied from interface: HostConnector

获取 channel

Specified by:

getChannel in interface HostConnector

Returns:

channel