public interface ISftpExecutor extends SafeCloseable
Modifier and Type | Method and Description |
---|---|
default void |
append(String path,
byte[] bs)
拼接 文件不存在则报错
|
void |
append(String path,
byte[] bs,
int off,
int len)
拼接 文件不存在则报错
|
void |
append(String path,
InputStream in)
拼接流 文件不存在则报错
|
default void |
append(String path,
String str)
拼接字符 文件不存在则报错
|
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)
设置文件名称编码格式
|
IFileDownloader |
download(String remote,
File local)
获取文件上传器
|
IFileDownloader |
download(String remote,
String local)
获取文件下载器
|
default void |
downloadDir(String remoteDir,
File localDir)
下载文件夹 递归
远程文件夹不存在/是个文件 则会报错
|
default void |
downloadDir(String remoteDir,
File localDir,
boolean child)
下载文件夹
远程文件夹不存在/是个文件 则会报错
|
default void |
downloadDir(String remoteDir,
String localDir)
下载文件夹 递归
远程文件夹不存在/是个文件 则会报错
|
void |
downloadDir(String remoteDir,
String localDir,
boolean child)
下载文件夹
远程文件夹不存在/是个文件 则会报错
|
default void |
downloadFile(String remoteFile,
File localFile)
下载文件
远程文件不存在则会报错
|
default void |
downloadFile(String remoteFile,
OutputStream out)
下载文件
远程文件不存在则会报错
|
void |
downloadFile(String remoteFile,
OutputStream out,
boolean close)
下载文件
远程文件不存在则会报错
|
void |
downloadFile(String remoteFile,
String localFile)
下载文件
远程文件不存在则会报错
|
int |
getBufferSize()
获取缓冲区大小
|
String |
getCharset()
获取文件名编码
|
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
|
default void |
hardLink(String source,
String target)
创建硬连接
原始文件不存在 则会报错
连接文件存在 则会报错
|
boolean |
isConnected()
会话是否已连接
|
boolean |
isExist(String path)
检查文件是否存在
文件不存在不会报错
|
void |
link(String source,
String target,
boolean hard)
创建连接文件
原始文件不存在 则会报错
连接文件存在 则会报错
|
List<SftpFile> |
list(String path)
获取目录文件属性
文件夹不存在则返回空
|
default List<SftpFile> |
listDirs(String path)
文件夹列表
文件夹不存在则返回空集合
|
List<SftpFile> |
listDirs(String path,
boolean child)
文件夹列表
文件夹不存在则返回空集合
|
default List<SftpFile> |
listFiles(String path)
文件列表
文件夹不存在则返回空
|
default List<SftpFile> |
listFiles(String path,
boolean child)
文件列表
文件夹不存在则返回空
|
List<SftpFile> |
listFiles(String path,
boolean child,
boolean dir)
文件列表
文件夹不存在则返回空集合
|
default List<SftpFile> |
listFilesFilter(String path,
SftpFileFilter filter)
查询文件列表
文件夹不存在则返回空集合
|
default List<SftpFile> |
listFilesFilter(String path,
SftpFileFilter filter,
boolean child)
查询文件列表
文件夹不存在则返回空集合
|
List<SftpFile> |
listFilesFilter(String path,
SftpFileFilter filter,
boolean child,
boolean dir)
查询文件列表
文件夹不存在则返回空集合
|
void |
makeDirectories(String path)
创建文件夹 递归
文件夹存在 父文件夹不存 不会报错
路径是文件并且已存在 则会报错
|
void |
makeDirectory(String path)
创建文件夹
文件夹存在 路径是文件并且已存在 父文件夹不存 则会报错
|
void |
move(String source,
String target)
移动文件 / 改名
原始文件存在 则会报错
目标文件存在 不会报错
|
default InputStream |
openInputStream(String path)
打开存在文件的输入流
文件不存在会报错
|
InputStream |
openInputStream(String path,
long skip)
打开存在文件的输入流
文件不存在会报错
|
default OutputStream |
openOutputStream(String path)
打开存在文件的输出流
文件不存在会创建
|
OutputStream |
openOutputStream(String path,
boolean append)
打开存在文件的输出流
文件不存在会创建
|
default int |
read(String path,
byte[] bs)
读取文件
文件不存在则报错
|
default int |
read(String path,
byte[] bs,
int offset,
int len)
读取文件
文件不存在则报错
|
default int |
read(String path,
long skip,
byte[] bs)
读取文件
文件不存在则报错
|
int |
read(String path,
long skip,
byte[] bs,
int offset,
int len)
读取文件
文件不存在则报错
|
void |
remove(String path)
递归删除文件或文件夹
文件不存在 不会报错
|
void |
removeDir(String path)
删除一个空的文件夹
文件夹不存在 不会报错
删除的是文件 不会报错 不会删除
不是空文件夹 会报错
|
void |
removeFile(String path)
删除一个普通文件
文件不存在 不会报错
删除的是文件夹 会报错
|
void |
sendSignal(String signal)
发送信号量
|
void |
setFileAttribute(SftpFile attribute)
设置文件属性
文件不存在则会报错
|
void |
setModifyTime(String path,
Date date)
设置文件修改时间
文件不存在则会报错
|
default void |
symLink(String source,
String target)
创建软连接文件
原始文件不存在 则会报错
连接文件存在 则会报错
|
void |
touch(String path)
创建文件
文件是与存在的文件夹则会报错
|
void |
touch(String path,
boolean truncate)
创建文件
文件是与存在的文件夹则会报错
|
void |
touchTruncate(String path)
创建文件 如果文件存在则截断
文件是与存在的文件夹则会报错
|
default long |
transfer(String path,
File file)
读取文件到本地
文件不存在则报错
|
default long |
transfer(String path,
File file,
long skip)
读取文件到本地
文件不存在则报错
|
default long |
transfer(String path,
OutputStream out)
读取字节到输出流
文件不存在则报错
|
default long |
transfer(String path,
OutputStream out,
long skip)
读取字节到输出流
文件不存在则报错
|
long |
transfer(String path,
OutputStream out,
long skip,
int size)
读取字节到输出流
文件不存在则报错
|
default long |
transfer(String path,
String file)
读取文件到本地
文件不存在则报错
|
long |
transfer(String path,
String file,
long skip)
读取文件到本地
文件不存在则报错
|
void |
truncate(String path)
清空文件, 没有则创建
文件是与存在的文件夹则会报错
|
IFileUploader |
upload(String remote,
File local)
获取文件上传器
|
IFileUploader |
upload(String remote,
String local)
获取文件上传器
|
default void |
uploadDir(String remoteDir,
File localDir)
上传文件夹 递归
/root/target > /home/ljh/target
如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错
远程文件夹是个文件则会报错
|
default void |
uploadDir(String remoteDir,
File localDir,
boolean child)
上传文件夹
/root/target > /home/ljh/target
如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错
远程文件夹是个文件则会报错
|
default void |
uploadDir(String remoteDir,
String localDir)
上传文件夹 递归
/root/target > /home/ljh/target
如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错
远程文件夹是个文件则会报错
|
void |
uploadDir(String remoteDir,
String localDir,
boolean child)
上传文件夹
/root/target > /home/ljh/target
如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错
远程文件夹是个文件则会报错
|
default void |
uploadFile(String remoteFile,
File localFile)
上传文件
远程文件存在则会覆盖
远程文件是个文件夹则会报错
|
default void |
uploadFile(String remoteFile,
InputStream in)
上传文件
远程文件存在则会覆盖
远程文件是个文件夹则会报错
|
void |
uploadFile(String remoteFile,
InputStream in,
boolean close)
上传文件
远程文件存在则会覆盖
远程文件是个文件夹则会报错
|
void |
uploadFile(String remoteFile,
String localFile)
上传文件
远程文件存在则会覆盖
远程文件是个文件夹则会报错
|
default void |
write(String path,
byte[] bs)
写入 文件不存在则报错
|
void |
write(String path,
byte[] bs,
int off,
int len)
写入 文件不存在则报错
|
void |
write(String path,
InputStream in)
写入流 文件不存在则报错
|
default void |
write(String path,
String str)
写入字符 文件不存在则报错
|
close
void bufferSize(int bufferSize)
bufferSize
- 缓冲区大小void charset(String charset)
charset
- 编码格式void sendSignal(String signal)
signal
- 信号String getHome()
boolean isExist(String path)
文件不存在不会报错
path
- 文件绝对路径String getLinkPath(String path)
文件不存在 不会报错 不是连接文件 不会报错
path
- 连接文件的绝对路径SftpFile getFile(String path, boolean followSymbolic)
文件不存在返回 null
path
- 文件绝对路径followSymbolic
- 如果是连接文件是否返回原文件属性long getSize(String path)
如果不存在返回 -1
path
- 文件绝对路径void setFileAttribute(SftpFile attribute)
文件不存在则会报错
attribute
- 文件属性void setModifyTime(String path, Date date)
文件不存在则会报错
path
- 文件绝对路径date
- 修改时间void changeMode(String file, int permission)
文件不存在则会报错
file
- 文件绝对路径permission
- 10进制表示的 8进制权限 如: 777void changeOwner(String file, int uid)
文件不存在则会报错
file
- 文件绝对路径uid
- 用户idvoid changeGroup(String file, int gid)
文件不存在则会报错
file
- 文件绝对路径gid
- 组idvoid makeDirectory(String path)
文件夹存在 路径是文件并且已存在 父文件夹不存 则会报错
path
- 文件夹绝对路径void makeDirectories(String path)
文件夹存在 父文件夹不存 不会报错 路径是文件并且已存在 则会报错
path
- 文件夹绝对路径void removeDir(String path)
文件夹不存在 不会报错 删除的是文件 不会报错 不会删除 不是空文件夹 会报错
path
- 绝对路径void removeFile(String path)
文件不存在 不会报错 删除的是文件夹 会报错
path
- 绝对路径void remove(String path)
文件不存在 不会报错
path
- 路径void touch(String path)
文件是与存在的文件夹则会报错
path
- 文件绝对路径void touchTruncate(String path)
文件是与存在的文件夹则会报错
path
- 文件绝对路径void touch(String path, boolean truncate)
文件是与存在的文件夹则会报错
path
- 文件绝对路径truncate
- 如果文件存在是否截断void truncate(String path)
文件是与存在的文件夹则会报错
path
- 文件绝对路径default void hardLink(String source, String target)
原始文件不存在 则会报错 连接文件存在 则会报错
source
- sourcetarget
- targetdefault void symLink(String source, String target)
原始文件不存在 则会报错 连接文件存在 则会报错
source
- sourcetarget
- targetvoid link(String source, String target, boolean hard)
原始文件不存在 则会报错 连接文件存在 则会报错
source
- sourcetarget
- targethard
- 是否为硬链接void move(String source, String target)
原始文件存在 则会报错 目标文件存在 不会报错
source
- 原文件绝对路径target
- 目标文件(绝对路径 相对路径) / 文件名称default InputStream openInputStream(String path) throws IOException
文件不存在会报错
path
- 文件路径IOException
- IOExceptionInputStream openInputStream(String path, long skip) throws IOException
文件不存在会报错
path
- 文件路径skip
- 跳过的字节IOException
- IOExceptiondefault OutputStream openOutputStream(String path) throws IOException
文件不存在会创建
path
- 文件路径IOException
- IOExceptionOutputStream openOutputStream(String path, boolean append) throws IOException
文件不存在会创建
path
- 文件路径append
- 是否为拼接IOException
- IOExceptiondefault int read(String path, byte[] bs) throws IOException
文件不存在则报错
path
- 文件绝对路径bs
- 字节数组IOException
- IOExceptiondefault int read(String path, byte[] bs, int offset, int len) throws IOException
文件不存在则报错
path
- 文件绝对路径bs
- 字节数组offset
- offsetlen
- lenIOException
- IOExceptiondefault int read(String path, long skip, byte[] bs) throws IOException
文件不存在则报错
path
- 文件绝对路径skip
- 跳过字节数bs
- 字节数组IOException
- IOExceptionint read(String path, long skip, byte[] bs, int offset, int len) throws IOException
文件不存在则报错
path
- 文件绝对路径skip
- 跳过字节数bs
- 字节数组offset
- offsetlen
- lenIOException
- IOExceptiondefault long transfer(String path, OutputStream out) throws IOException
文件不存在则报错
path
- 文件绝对路径out
- 输出流IOException
- IOExceptiondefault long transfer(String path, OutputStream out, long skip) throws IOException
文件不存在则报错
path
- 文件绝对路径out
- 输出流skip
- 跳过字数IOException
- IOExceptionlong transfer(String path, OutputStream out, long skip, int size) throws IOException
文件不存在则报错
path
- 文件绝对路径out
- 输出流skip
- 跳过字数size
- 读取长度 -1 读取全部IOException
- IOExceptiondefault long transfer(String path, File file) throws IOException
文件不存在则报错
path
- 文件绝对路径file
- 本地文件IOException
- IOExceptiondefault long transfer(String path, File file, long skip) throws IOException
文件不存在则报错
path
- 文件绝对路径file
- 本地文件skip
- 跳过字数IOException
- IOExceptiondefault long transfer(String path, String file) throws IOException
文件不存在则报错
path
- 文件绝对路径file
- 本地文件路径IOException
- IOExceptionlong transfer(String path, String file, long skip) throws IOException
文件不存在则报错
path
- 文件绝对路径file
- 本地文件路径skip
- 跳过字数IOException
- IOExceptionvoid write(String path, InputStream in) throws IOException
path
- pathin
- inIOException
- IOExceptiondefault void write(String path, String str) throws IOException
path
- pathstr
- strIOException
- IOExceptiondefault void write(String path, byte[] bs) throws IOException
path
- pathbs
- bsIOException
- IOExceptionvoid write(String path, byte[] bs, int off, int len) throws IOException
path
- pathbs
- bsoff
- offlen
- lenIOException
- IOExceptionvoid append(String path, InputStream in) throws IOException
path
- pathin
- inIOException
- IOExceptiondefault void append(String path, String str) throws IOException
path
- pathstr
- strIOException
- IOExceptiondefault void append(String path, byte[] bs) throws IOException
path
- pathbs
- bsIOException
- IOExceptionvoid append(String path, byte[] bs, int off, int len) throws IOException
path
- pathbs
- bsoff
- offlen
- lenIOException
- IOExceptiondefault void uploadFile(String remoteFile, File localFile) throws IOException
远程文件存在则会覆盖 远程文件是个文件夹则会报错
remoteFile
- 远程文件localFile
- 本地文件IOException
- IOExceptionvoid uploadFile(String remoteFile, String localFile) throws IOException
远程文件存在则会覆盖 远程文件是个文件夹则会报错
remoteFile
- 远程文件localFile
- 本地文件IOException
- IOExceptiondefault void uploadFile(String remoteFile, InputStream in) throws IOException
远程文件存在则会覆盖 远程文件是个文件夹则会报错
remoteFile
- 远程文件in
- 流IOException
- IOExceptionvoid uploadFile(String remoteFile, InputStream in, boolean close) throws IOException
远程文件存在则会覆盖
远程文件是个文件夹则会报错
remoteFile
- 远程文件in
- inputclose
- closeIOException
- IOExceptiondefault void uploadDir(String remoteDir, File localDir) throws IOException
/root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错 远程文件夹是个文件则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹 上传时不包含此文件夹IOException
- IOExceptiondefault void uploadDir(String remoteDir, String localDir) throws IOException
/root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错 远程文件夹是个文件则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹 上传时不包含此文件夹IOException
- IOExceptiondefault void uploadDir(String remoteDir, File localDir, boolean child) throws IOException
/root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错 远程文件夹是个文件则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹 上传时不包含此文件夹child
- 是否遍历上传IOException
- IOExceptionvoid uploadDir(String remoteDir, String localDir, boolean child) throws IOException
/root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root
远程文件夹不存在不会报错 远程文件夹是个文件则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹 上传时不包含此文件夹child
- 是否遍历上传IOException
- IOExceptiondefault void downloadFile(String remoteFile, File localFile) throws IOException
远程文件不存在则会报错
remoteFile
- 远程文件路径localFile
- 本地文件路径IOException
- IOExceptionvoid downloadFile(String remoteFile, String localFile) throws IOException
远程文件不存在则会报错
remoteFile
- 远程文件路径localFile
- 本地文件路径IOException
- IOExceptiondefault void downloadFile(String remoteFile, OutputStream out) throws IOException
远程文件不存在则会报错
remoteFile
- 远程文件路径out
- outputIOException
- IOExceptionvoid downloadFile(String remoteFile, OutputStream out, boolean close) throws IOException
远程文件不存在则会报错
remoteFile
- 远程文件路径out
- outputclose
- 是否自动关闭IOException
- IOExceptiondefault void downloadDir(String remoteDir, File localDir) throws IOException
远程文件夹不存在/是个文件 则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹IOException
- IOExceptiondefault void downloadDir(String remoteDir, String localDir) throws IOException
远程文件夹不存在/是个文件 则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹IOException
- IOExceptiondefault void downloadDir(String remoteDir, File localDir, boolean child) throws IOException
远程文件夹不存在/是个文件 则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹child
- 是否递归子文件夹下载IOException
- IOExceptionvoid downloadDir(String remoteDir, String localDir, boolean child) throws IOException
远程文件夹不存在/是个文件 则会报错
remoteDir
- 远程文件夹localDir
- 本地文件夹child
- 是否递归子文件夹下载IOException
- IOExceptionIFileUploader upload(String remote, File local)
remote
- 远程文件绝对路径local
- 本地文件IFileUploader upload(String remote, String local)
remote
- 远程文件绝对路径local
- 本地文件IFileDownloader download(String remote, File local)
remote
- 远程文件绝对路径local
- 本地文件IFileDownloader download(String remote, String local)
remote
- 远程文件绝对路径local
- 本地文件default List<SftpFile> listFiles(String path)
文件夹不存在则返回空
path
- 文件夹绝对路径default List<SftpFile> listFiles(String path, boolean child)
文件夹不存在则返回空
path
- 文件夹绝对路径child
- 是否递归子文件夹List<SftpFile> listFiles(String path, boolean child, boolean dir)
文件夹不存在则返回空集合
path
- 文件夹绝对路径child
- 是否递归子文件夹dir
- 是否添加文件夹default List<SftpFile> listDirs(String path)
文件夹不存在则返回空集合
path
- 文件夹绝对路径List<SftpFile> listDirs(String path, boolean child)
文件夹不存在则返回空集合
path
- 文件夹绝对路径child
- 是否递归default List<SftpFile> listFilesFilter(String path, SftpFileFilter filter)
文件夹不存在则返回空集合
path
- 文件夹绝对路径filter
- 过滤器default List<SftpFile> listFilesFilter(String path, SftpFileFilter filter, boolean child)
文件夹不存在则返回空集合
path
- 文件夹绝对路径filter
- 过滤器child
- 是否递归子文件夹List<SftpFile> listFilesFilter(String path, SftpFileFilter filter, boolean child, boolean dir)
文件夹不存在则返回空集合
path
- 文件夹绝对路径filter
- 过滤器child
- 是否递归子文件夹dir
- 是否添加文件夹boolean isConnected()
int getServerVersion()
int getBufferSize()
String getCharset()
Copyright © 2024. All rights reserved.