public interface IFtpInstance extends SafeCloseable, Destroyable
Modifier and Type | Method and Description |
---|---|
default void |
append(String file,
byte[] bs)
拼接字节数组到文件
文件不存在则自动创建
|
void |
append(String file,
byte[] bs,
int off,
int len)
拼接字节数组到文件
文件不存在则自动创建
|
void |
append(String file,
InputStream in)
拼接流到文件
文件不存在则自动创建
|
default void |
append(String file,
String str)
拼接字符
文件不存在则自动创建
|
void |
change()
切换至根目录
|
void |
change(String dir)
切换目录
目标目录不存在不会报错
|
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)
下载文件
|
org.apache.commons.net.ftp.FTPClient |
getClient()
获取连接
|
FtpConfig |
getConfig()
获取配置
|
FtpFile |
getFile(String file)
获取文件属性
文件不存在不会报错
|
long |
getModifyTime(String file)
获取文件最后修改时间
文件不存在返回 -1
|
FtpClientPool |
getPool()
获取连接池
|
long |
getSize(String file)
获取文件大小
文件不存在返回 -1
|
String |
getStatus()
获取文件夹状态
|
String |
getStatus(String path)
获取文件夹状态 会获取文件列表
|
String |
getSystemType()
获取系统类型
|
String |
getWorkDirectory()
获取工作目录
|
boolean |
isExist(String file)
文件是否存在
文件不存在不会报错
|
default List<FtpFile> |
listDirs(String path)
列出目录下的文件
|
List<FtpFile> |
listDirs(String path,
boolean child)
列出文件夹
|
default List<FtpFile> |
listFiles(String path)
列出目录下的文件
|
default List<FtpFile> |
listFiles(String path,
boolean child)
列出目录下的文件
|
List<FtpFile> |
listFiles(String path,
boolean child,
boolean dir)
文件和文件夹列表
|
default List<FtpFile> |
listFilesFilter(String path,
FtpFileFilter filter)
列出目录下的文件
|
default List<FtpFile> |
listFilesFilter(String path,
FtpFileFilter filter,
boolean child)
列出目录下的文件
|
List<FtpFile> |
listFilesFilter(String path,
FtpFileFilter filter,
boolean child,
boolean dir)
列出目录下的文件
|
String |
localCharset(String chars)
本地编码
|
void |
makeDirectories(String dir)
创建文件夹
文件夹已存在或存在的为文件不会报错
|
void |
move(String source,
String target)
文件移动/重命名
文件不存在不会报错
目标文件存在不会报错
|
default InputStream |
openInputStream(String file)
获取文件输入流
文件不存在则报错
使用完毕需要调用 client.completePendingCommand();
这个操作在关闭 io 之后 | finally 中
|
InputStream |
openInputStream(String file,
long skip)
获取文件输入流
文件不存在则报错
使用完毕需要调用 client.completePendingCommand();
这个操作在关闭 io 之后 | finally 中
|
default OutputStream |
openOutputStream(String file)
获取文件输出流
文件存在则自动创建
使用完毕需要调用 client.completePendingCommand();
这个操作在关闭 io 之后 | finally 中
|
OutputStream |
openOutputStream(String file,
boolean append)
获取文件输出流
文件存在则自动创建
使用完毕需要调用 client.completePendingCommand();
这个操作在关闭 io 之后 | finally 中
|
boolean |
pending()
等待处理命令完毕 事务
|
default int |
read(String file,
byte[] bs)
读取文件到数组
文件不存在则报错
|
default int |
read(String file,
byte[] bs,
int off,
int len)
读取文件到数组
文件不存在则报错
|
default int |
read(String file,
long skip,
byte[] bs)
读取文件到数组
文件不存在则报错
|
int |
read(String file,
long skip,
byte[] bs,
int off,
int len)
读取文件到数组
文件不存在则报错
|
void |
remove(String file)
删除文件或递归删除文件及目录
文件不存在不会报错
|
void |
removeDir(String dir)
递归删除目录及文件
文件不存在不会报错
删除的是文件不会报错
|
void |
removeFile(String file)
删除文件
文件不存在不会报错
删除的是文件夹不会报错
|
boolean |
reply()
获取上一次命令的reply
|
int |
replyCode()
获取上一次命令的 replyCode
|
String |
replyMsg()
获取上一次命令的 replyCode 对应的 message
|
void |
reset()
重置 io
|
void |
restartOffset(long offset)
设置偏移量
|
boolean |
sendNoop()
发送心跳
|
String |
serverCharset(String chars)
ftp 服务文件编码
|
void |
setModifyTime(String file,
Date time)
设置文件最后修改时间
文件不存在则会报错
|
void |
touch(String file)
创建文件
文件已存在不会报错
|
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)
读取字节到文件
文件不存在则报错
|
default long |
transfer(String path,
String file,
long skip)
读取字节到文件
文件不存在则报错
|
long |
transfer(String path,
String file,
long skip,
int size)
读取字节到文件
文件不存在则报错
|
void |
truncate(String file)
清空文件
如果文件不存在不会报错
如果是文件夹则会报错
|
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 file,
byte[] bs)
写入字节数组到文件
文件不存在则自动创建
|
void |
write(String file,
byte[] bs,
int off,
int len)
写入字节数组到文件
文件不存在则自动创建
|
void |
write(String file,
InputStream in)
写入流到文件
文件不存在则自动创建
|
default void |
write(String file,
String str)
写入字符
文件不存在则自动创建
|
close
destroy
void change()
void change(String dir)
目标目录不存在不会报错
dir
- dirString getWorkDirectory()
int replyCode()
String replyMsg()
boolean reply()
boolean isExist(String file)
文件不存在不会报错
file
- 文件long getSize(String file)
文件不存在返回 -1
file
- filelong getModifyTime(String file)
文件不存在返回 -1
file
- filevoid setModifyTime(String file, Date time)
文件不存在则会报错
file
- filetime
- timevoid truncate(String file) throws IOException
如果文件不存在不会报错 如果是文件夹则会报错
file
- fileIOException
- IOExceptionvoid remove(String file)
文件不存在不会报错
file
- filevoid removeFile(String file)
文件不存在不会报错 删除的是文件夹不会报错
file
- 文件void removeDir(String dir)
文件不存在不会报错 删除的是文件不会报错
dir
- 目录void makeDirectories(String dir)
文件夹已存在或存在的为文件不会报错
dir
- 文件夹void touch(String file)
文件已存在不会报错
file
- 文件void move(String source, String target)
文件不存在不会报错 目标文件存在不会报错
source
- 原文件路径target
- 移动后的路径 可以为相对路径 如果不加目录为重命名default InputStream openInputStream(String file) throws IOException
文件不存在则报错 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中
file
- 文件IOException
- IOExceptionInputStream openInputStream(String file, long skip) throws IOException
文件不存在则报错 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中
file
- 文件skip
- 跳过字节数IOException
- IOExceptiondefault OutputStream openOutputStream(String file) throws IOException
文件存在则自动创建 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中
file
- 文件IOException
- IOExceptionOutputStream openOutputStream(String file, boolean append) throws IOException
文件存在则自动创建 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中
file
- 文件append
- 是否为拼接IOException
- IOExceptiondefault int read(String file, byte[] bs) throws IOException
文件不存在则报错
file
- 文件bs
- 数组IOException
- IOExceptiondefault int read(String file, long skip, byte[] bs) throws IOException
文件不存在则报错
file
- 文件skip
- 跳过字节数bs
- 数组IOException
- IOExceptiondefault int read(String file, byte[] bs, int off, int len) throws IOException
文件不存在则报错
file
- 文件bs
- 数组off
- 偏移量len
- 长度IOException
- IOExceptionint read(String file, long skip, byte[] bs, int off, int len) throws IOException
文件不存在则报错
file
- 文件skip
- 跳过字节数bs
- 数组off
- 偏移量len
- 长度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
- IOExceptiondefault long transfer(String path, String file, long skip) throws IOException
文件不存在则报错
path
- 文件绝对路径file
- 输出流skip
- 跳过字数IOException
- IOExceptionlong transfer(String path, String file, long skip, int size) throws IOException
文件不存在则报错
path
- 文件绝对路径file
- 输出流skip
- 跳过字数size
- 读取长度 -1 读取全部IOException
- 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
- IOExceptionvoid write(String file, InputStream in) throws IOException
文件不存在则自动创建
file
- 文件in
- inIOException
- IOExceptiondefault void write(String file, String str) throws IOException
文件不存在则自动创建
file
- 文件str
- strIOException
- IOExceptiondefault void write(String file, byte[] bs) throws IOException
文件不存在则自动创建
file
- 文件bs
- 字节数组IOException
- IOExceptionvoid write(String file, byte[] bs, int off, int len) throws IOException
文件不存在则自动创建
file
- 文件bs
- 字节数组off
- 偏移量len
- 长度IOException
- IOExceptionvoid append(String file, InputStream in) throws IOException
文件不存在则自动创建
file
- 文件in
- inIOException
- IOExceptiondefault void append(String file, String str) throws IOException
文件不存在则自动创建
file
- 文件str
- strIOException
- IOExceptiondefault void append(String file, byte[] bs) throws IOException
文件不存在则自动创建
file
- 文件bs
- 字节数组IOException
- IOExceptionvoid append(String file, byte[] bs, int off, int len) throws IOException
文件不存在则自动创建
file
- 文件bs
- 字节数组off
- 偏移量len
- 长度IOException
- 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
- inputIOException
- 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
- pendingvoid downloadFile(String remoteFile, String localFile) throws IOException
remoteFile
- 远程文件路径localFile
- 本地文件IOException
- pendingdefault void downloadFile(String remoteFile, OutputStream out) throws IOException
remoteFile
- 远程文件路径out
- outputIOException
- pendingvoid downloadFile(String remoteFile, OutputStream out, boolean close) throws IOException
remoteFile
- 远程文件路径out
- outputclose
- 是否自动关闭IOException
- pendingdefault void downloadDir(String remoteDir, File localDir) throws IOException
remoteDir
- 远程文件夹localDir
- 本地文件夹IOException
- pendingdefault void downloadDir(String remoteDir, String localDir) throws IOException
remoteDir
- 远程文件夹localDir
- 本地文件夹IOException
- pendingdefault void downloadDir(String remoteDir, File localDir, boolean child) throws IOException
remoteDir
- 远程文件夹localDir
- 本地文件夹child
- 是否递归子文件夹下载IOException
- pendingvoid downloadDir(String remoteDir, String localDir, boolean child) throws IOException
remoteDir
- 远程文件夹localDir
- 本地文件夹child
- 是否递归子文件夹下载IOException
- pendingIFileUploader upload(String remote, String local)
remote
- 远程文件local
- 本地文件IFileUploader upload(String remote, File local)
remote
- 远程文件local
- 本地文件IFileDownloader download(String remote, String local)
remote
- 远程文件local
- 本地文件IFileDownloader download(String remote, File local)
remote
- 远程文件local
- 本地文件default List<FtpFile> listFiles(String path, boolean child)
path
- 目录child
- 是否递归子文件夹List<FtpFile> listFiles(String path, boolean child, boolean dir)
path
- 路径child
- 是否遍历子目录dir
- 是否添加文件夹List<FtpFile> listDirs(String path, boolean child)
path
- 路径child
- 是否遍历default List<FtpFile> listFilesFilter(String path, FtpFileFilter filter)
path
- 目录filter
- 过滤器default List<FtpFile> listFilesFilter(String path, FtpFileFilter filter, boolean child)
path
- 目录filter
- 过滤器child
- 是否递归子文件夹List<FtpFile> listFilesFilter(String path, FtpFileFilter filter, boolean child, boolean dir)
path
- 目录filter
- 过滤器child
- 是否递归子文件夹dir
- 是否添加文件夹boolean pending() throws IOException
IOException
- IOExceptionvoid restartOffset(long offset)
offset
- offsetvoid reset()
String getSystemType()
String getStatus()
org.apache.commons.net.ftp.FTPClient getClient()
FtpConfig getConfig()
FtpClientPool getPool()
boolean sendNoop() throws IOException
IOException
- IOExceptionCopyright © 2024. All rights reserved.