cn.orionsec.kit.net.ftp.client.instance

Class FtpInstance

java.lang.Object

cn.orionsec.kit.net.ftp.client.instance.BaseFtpInstance

cn.orionsec.kit.net.ftp.client.instance.FtpInstance

All Implemented Interfaces:

Destroyable, SafeCloseable, IFtpInstance, Closeable, AutoCloseable

public class FtpInstance
extends BaseFtpInstance

FTP 操作实例

Since:

2020/3/17 16:10

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields inherited from class cn.orionsec.kit.net.ftp.client.instance.BaseFtpInstance

bufferSize, client, config, pool, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
FtpInstance(org.apache.commons.net.ftp.FTPClient client, FtpConfig config)
FtpInstance(FtpClientPool pool)

Method Summary

Modifier and Type	Method and Description
void	change() 切换至根目录
void	change(String dir) 切换目录 目标目录不存在不会报错
protected void	doAppend(String path, InputStream in, StreamEntry entry) 执行拼接
protected long	doTransfer(String path, OutputStream out, long skip, int size, boolean close) 执行传输
FtpDownloader	download(String remote, File local) 获取大文件下载器
FtpDownloader	download(String remote, String local) 获取大文件下载器
void	downloadDir(String remoteDir, String localDir, boolean child) 下载文件夹
void	downloadFile(String remoteFile, OutputStream out, boolean close) 下载文件
protected void	doWrite(String path, InputStream in, StreamEntry entry) 执行写入
FtpFile	getFile(String file) 获取文件属性 文件不存在不会报错
long	getModifyTime(String file) 获取文件最后修改时间 文件不存在返回 -1
long	getSize(String file) 获取文件大小 文件不存在返回 -1
String	getWorkDirectory() 获取工作目录
boolean	isExist(String file) 文件是否存在 文件不存在不会报错
List<FtpFile>	listFilesFilter(String path, FtpFileFilter filter, boolean child, boolean dir) 列出目录下的文件
void	makeDirectories(String dir) 创建文件夹 文件夹已存在或存在的为文件不会报错
void	move(String source, String target) 文件移动/重命名 文件不存在不会报错 目标文件存在不会报错
InputStream	openInputStream(String file, long skip) 获取文件输入流 文件不存在则报错 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中
OutputStream	openOutputStream(String file, boolean append) 获取文件输出流 文件存在则自动创建 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中
int	read(String file, long skip, byte[] bs, int off, int len) 读取文件到数组 文件不存在则报错
void	remove(String file) 删除文件或递归删除文件及目录 文件不存在不会报错
void	removeDir(String dir) 递归删除目录及文件 文件不存在不会报错 删除的是文件不会报错
void	removeFile(String file) 删除文件 文件不存在不会报错 删除的是文件夹不会报错
void	setModifyTime(String file, Date time) 设置文件最后修改时间 文件不存在则会报错
void	touch(String file) 创建文件 文件已存在不会报错
void	truncate(String file) 清空文件 如果文件不存在不会报错 如果是文件夹则会报错
FtpUploader	upload(String remote, File local) 获取大文件上传器
FtpUploader	upload(String remote, String local) 获取大文件下载器
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) 上传文件 远程文件存在则会覆盖 远程文件是个文件夹则会报错

Methods inherited from class cn.orionsec.kit.net.ftp.client.instance.BaseFtpInstance

append, append, close, destroy, downloadFile, getClient, getConfig, getPool, getStatus, getStatus, getSystemType, listDirs, listFiles, localCharset, pending, reply, replyCode, replyMsg, reset, restartOffset, sendNoop, serverCharset, transfer, transfer, 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.ftp.client.instance.IFtpInstance

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

Constructor Detail

FtpInstance

public FtpInstance(FtpClientPool pool)

FtpInstance

public FtpInstance(org.apache.commons.net.ftp.FTPClient client,
                   FtpConfig config)

Method Detail

change

public void change()

Description copied from interface: IFtpInstance

切换至根目录

change

public void change(String dir)

Description copied from interface: IFtpInstance

切换目录

目标目录不存在不会报错

Parameters:

dir - dir

getWorkDirectory

public String getWorkDirectory()

Description copied from interface: IFtpInstance

获取工作目录

Returns:

当前工作目录

isExist

public boolean isExist(String file)

Description copied from interface: IFtpInstance

文件是否存在

文件不存在不会报错

Parameters:

file - 文件

Returns:

true存在

getFile

public FtpFile getFile(String file)

Description copied from interface: IFtpInstance

获取文件属性

文件不存在不会报错

Parameters:

file - 文件

Returns:

未找到返回null

getSize

public long getSize(String file)

Description copied from interface: IFtpInstance

获取文件大小

文件不存在返回 -1

Parameters:

file - file

Returns:

size

getModifyTime

public long getModifyTime(String file)

Description copied from interface: IFtpInstance

获取文件最后修改时间

文件不存在返回 -1

Parameters:

file - file

Returns:

time

setModifyTime

public void setModifyTime(String file,
                          Date time)

Description copied from interface: IFtpInstance

设置文件最后修改时间

文件不存在则会报错

Parameters:

file - file

time - time

truncate

public void truncate(String file)
              throws IOException

Description copied from interface: IFtpInstance

清空文件

如果文件不存在不会报错 如果是文件夹则会报错

Parameters:

file - file

Throws:

IOException - IOException

remove

public void remove(String file)

Description copied from interface: IFtpInstance

删除文件或递归删除文件及目录

文件不存在不会报错

Parameters:

file - file

removeFile

public void removeFile(String file)

Description copied from interface: IFtpInstance

删除文件

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

Parameters:

file - 文件

removeDir

public void removeDir(String dir)

Description copied from interface: IFtpInstance

递归删除目录及文件

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

Parameters:

dir - 目录

makeDirectories

public void makeDirectories(String dir)

Description copied from interface: IFtpInstance

创建文件夹

文件夹已存在或存在的为文件不会报错

Parameters:

dir - 文件夹

touch

public void touch(String file)

Description copied from interface: IFtpInstance

创建文件

文件已存在不会报错

Parameters:

file - 文件

move

public void move(String source,
                 String target)

Description copied from interface: IFtpInstance

文件移动/重命名

文件不存在不会报错 目标文件存在不会报错

Parameters:

source - 原文件路径

target - 移动后的路径 可以为相对路径 如果不加目录为重命名

openInputStream

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

Description copied from interface: IFtpInstance

获取文件输入流

文件不存在则报错 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中

Parameters:

file - 文件

skip - 跳过字节数

Returns:

InputStream

Throws:

IOException - IOException

openOutputStream

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

Description copied from interface: IFtpInstance

获取文件输出流

文件存在则自动创建 使用完毕需要调用 client.completePendingCommand(); 这个操作在关闭 io 之后 | finally 中

Parameters:

file - 文件

append - 是否为拼接

Returns:

OutputStream

Throws:

IOException - IOException

read

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

Description copied from interface: IFtpInstance

读取文件到数组

文件不存在则报错

Parameters:

file - 文件

skip - 跳过字节数

bs - 数组

off - 偏移量

len - 长度

Returns:

读取的长度

Throws:

IOException - IOException

doTransfer

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

Description copied from class: BaseFtpInstance

执行传输

Specified by:

doTransfer in class BaseFtpInstance

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: BaseFtpInstance

执行写入

Specified by:

doWrite in class BaseFtpInstance

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: BaseFtpInstance

执行拼接

Specified by:

doAppend in class BaseFtpInstance

Parameters:

path - path

in - in

entry - entry

Throws:

IOException - IOException

uploadFile

public void uploadFile(String remoteFile,
                       InputStream in,
                       boolean close)
                throws IOException

Description copied from interface: IFtpInstance

上传文件

远程文件存在则会覆盖

远程文件是个文件夹则会报错

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: IFtpInstance

上传文件夹

/root/target > /home/ljh/target 如果远程文件夹不设置 /target 则会将 /home/ljh/target 的文件传输到 /root

远程文件夹不存在不会报错 远程文件夹是个文件则会报错

Parameters:

remoteDir - 远程文件夹

localDir - 本地文件夹 上传时不包含此文件夹

child - 是否遍历上传

Throws:

IOException - IOException

downloadFile

public void downloadFile(String remoteFile,
                         OutputStream out,
                         boolean close)
                  throws IOException

Description copied from interface: IFtpInstance

下载文件

Parameters:

remoteFile - 远程文件路径

out - output

close - 是否自动关闭

Throws:

IOException - pending

downloadDir

public void downloadDir(String remoteDir,
                        String localDir,
                        boolean child)
                 throws IOException

Description copied from interface: IFtpInstance

下载文件夹

Parameters:

remoteDir - 远程文件夹

localDir - 本地文件夹

child - 是否递归子文件夹下载

Throws:

IOException - pending

upload

public FtpUploader upload(String remote,
                          String local)

Description copied from interface: IFtpInstance

获取大文件下载器

Parameters:

remote - 远程文件

local - 本地文件

Returns:

FtpDownload

upload

public FtpUploader upload(String remote,
                          File local)

Description copied from interface: IFtpInstance

获取大文件上传器

Parameters:

remote - 远程文件

local - 本地文件

Returns:

FtpUpload

download

public FtpDownloader download(String remote,
                              String local)

Description copied from interface: IFtpInstance

获取大文件下载器

Parameters:

remote - 远程文件

local - 本地文件

Returns:

FtpDownload

download

public FtpDownloader download(String remote,
                              File local)

Description copied from interface: IFtpInstance

获取大文件下载器

Parameters:

remote - 远程文件

local - 本地文件

Returns:

FtpDownload

listFilesFilter

public List<FtpFile> listFilesFilter(String path,
                                     FtpFileFilter filter,
                                     boolean child,
                                     boolean dir)

Description copied from interface: IFtpInstance

列出目录下的文件

Parameters:

path - 目录

filter - 过滤器

child - 是否递归子文件夹

dir - 是否添加文件夹

Returns:

文件