cn.orionsec.kit.net.specification.transfer

Class BaseFileUploader

java.lang.Object

cn.orionsec.kit.net.specification.transfer.BaseFileUploader

All Implemented Interfaces:

SafeCloseable, IFileTransfer, IFileUploader, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

FtpUploader, SftpUploader

public abstract class BaseFileUploader
extends Object
implements IFileUploader

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

Since:

2021/3/14 00:07

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

Modifier	Constructor and Description
protected	BaseFileUploader(String remote, File local, String lockSuffix, int bufferSize)

Method Summary

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

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

BaseFileUploader

protected BaseFileUploader(String remote,
                           File local,
                           String lockSuffix,
                           int bufferSize)

Method Detail

forceOverride

public void forceOverride(boolean forceOverride)

Description copied from interface: IFileUploader

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

Specified by:

forceOverride in interface IFileUploader

Parameters:

forceOverride - 是否覆盖

fileSizeEqualOverride

public void fileSizeEqualOverride(boolean fileSizeEqualOverride)

Description copied from interface: IFileUploader

文件大小相同则覆盖上传

Specified by:

fileSizeEqualOverride in interface IFileUploader

Parameters:

fileSizeEqualOverride - fileSizeEqualOverride

getRemoteFileLength

public long getRemoteFileLength()
                         throws IOException

Description copied from interface: IFileUploader

获取远程文件大小

Specified by:

getRemoteFileLength in interface IFileUploader

Returns:

fileSize 文件不存在则返回 -1

Throws:

IOException - IOException

checkRemoteFilePresentSizeEqual

public boolean checkRemoteFilePresentSizeEqual()
                                        throws IOException

Description copied from interface: IFileUploader

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

Specified by:

checkRemoteFilePresentSizeEqual in interface IFileUploader

Returns:

是否相等

Throws:

IOException - IOException

startUpload

protected void startUpload()
                    throws IOException

开始上传

Throws:

IOException - IOException

upload

protected void upload()
               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

initUpload

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

准开始上传

Parameters:

breakPoint - 是否为断点续传

skip - skip

Throws:

IOException - IOException

write

protected abstract void write(byte[] bs,
                              int len)
                       throws IOException

写入

Parameters:

bs - bs

len - 长度

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:

传输进度条