cn.orionsec.kit.net.specification.transfer

Class BaseFileDownloader

java.lang.Object

cn.orionsec.kit.net.specification.transfer.BaseFileDownloader

All Implemented Interfaces:

SafeCloseable, IFileDownloader, IFileTransfer, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

FtpDownloader, SftpDownloader

public abstract class BaseFileDownloader
extends Object
implements IFileDownloader

大文件下载 基类 支持断点续传, 实时速率

Since:

2021/3/14 13:30

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferSize 缓冲区大小
protected boolean	fileSizeEqualOverride 文件大小相同则覆盖下载
protected boolean	forceOverride 是否强制覆盖下载 (不检测文件锁定/不检测文件大小/不走断点续传)
protected File	local 本地文件
protected FileLocks.NamedFileLock	lock 文件锁
protected ByteTransferRateProgress	progress 进度条
protected String	remote 远程文件
protected Long	remoteFileLength 远程文件大小 缓存

Constructor Summary

Constructors

Constructor and Description
BaseFileDownloader(String remote, File local, String lockSuffix, int bufferSize)

Method Summary

Modifier and Type	Method and Description
protected void	breakPointResume(long skip) 断点续传
boolean	checkRemoteFilePresentSizeEqual() 检查远程文件存在并且大小相同
protected void	download() 直接下载
void	fileSizeEqualOverride(boolean fileSizeEqualOverride) 文件大小相同则覆盖下载
void	forceOverride(boolean forceOverride) 强制覆盖下载 (不检测文件锁定/不检测文件大小/不走断点续传)
ByteTransferRateProgress	getProgress() 获取传输进度条
long	getRemoteFileLength() 获取远程文件大小
protected abstract long	getRemoteFileSize() 获取远程文件大小
protected abstract void	initDownload(boolean breakPoint, long skip) 准开始下载
protected abstract int	read(byte[] bs) 读取数据
protected void	startDownload() 开始下载
protected abstract void	transferFinish() 传输完成回调

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.specification.transfer.IFileTransfer

abort

Methods inherited from interface java.lang.Runnable

run

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

close

Field Detail

remote

protected final String remote

远程文件

local

protected final File local

本地文件

lock

protected final FileLocks.NamedFileLock lock

文件锁

progress

protected final ByteTransferRateProgress progress

进度条

bufferSize

protected int bufferSize

缓冲区大小

forceOverride

protected boolean forceOverride

是否强制覆盖下载 (不检测文件锁定/不检测文件大小/不走断点续传)

fileSizeEqualOverride

protected boolean fileSizeEqualOverride

文件大小相同则覆盖下载

remoteFileLength

protected Long remoteFileLength

远程文件大小 缓存

Constructor Detail

BaseFileDownloader

public BaseFileDownloader(String remote,
                          File local,
                          String lockSuffix,
                          int bufferSize)

Method Detail

forceOverride

public void forceOverride(boolean forceOverride)

Description copied from interface: IFileDownloader

强制覆盖下载 (不检测文件锁定/不检测文件大小/不走断点续传)

Specified by:

forceOverride in interface IFileDownloader

Parameters:

forceOverride - 是否覆盖

fileSizeEqualOverride

public void fileSizeEqualOverride(boolean fileSizeEqualOverride)

Description copied from interface: IFileDownloader

文件大小相同则覆盖下载

Specified by:

fileSizeEqualOverride in interface IFileDownloader

Parameters:

fileSizeEqualOverride - fileSizeEqualOverride

getRemoteFileLength

public long getRemoteFileLength()
                         throws IOException

Description copied from interface: IFileDownloader

获取远程文件大小

Specified by:

getRemoteFileLength in interface IFileDownloader

Returns:

fileSize 文件不存在则返回 -1

Throws:

IOException - IOException

checkRemoteFilePresentSizeEqual

public boolean checkRemoteFilePresentSizeEqual()
                                        throws IOException

Description copied from interface: IFileDownloader

检查远程文件存在并且大小相同

Specified by:

checkRemoteFilePresentSizeEqual in interface IFileDownloader

Returns:

是否相等

Throws:

IOException - IOException

startDownload

protected void startDownload()
                      throws IOException

开始下载

Throws:

IOException - IOException

download

protected void download()
                 throws IOException

直接下载

Throws:

IOException - IOException

breakPointResume

protected void breakPointResume(long skip)
                         throws IOException

断点续传

Parameters:

skip - 跳过的长度

Throws:

IOException - IOException

getRemoteFileSize

protected abstract long getRemoteFileSize()
                                   throws IOException

获取远程文件大小

Returns:

fileSize 文件不存在则返回-1

Throws:

IOException - IOException

initDownload

protected abstract void initDownload(boolean breakPoint,
                                     long skip)
                              throws IOException

准开始下载

Parameters:

breakPoint - 是否为断点续传

skip - 跳过的长度

Throws:

IOException - IOException

read

protected abstract int read(byte[] bs)
                     throws IOException

读取数据

Parameters:

bs - bs

Returns:

长度

Throws:

IOException - IOException

transferFinish

protected abstract void transferFinish()
                                throws IOException

传输完成回调

Throws:

IOException - IOException

getProgress

public ByteTransferRateProgress getProgress()

Description copied from interface: IFileTransfer

获取传输进度条

Specified by:

getProgress in interface IFileTransfer

Returns:

传输进度条