com.tencent.cos.xml.transfer

类 COSTransferTask

java.lang.Object

com.tencent.cos.xml.transfer.COSTransferTask

直接已知子类:

COSDownloadTask, COSUploadTask

public abstract class COSTransferTask
extends java.lang.Object

传输任务

Created by rickenwang on 2021/6/30. Copyright 2010-2021 Tencent Cloud. All Rights Reserved.

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	COSTransferTask.TaskThreadFactory

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	bucket
protected CosXmlClientException	clientException
protected COSDirect	cosDirect
protected CosXmlProgressListener	cosXmlProgressListener
protected CosXmlRequest	cosXmlRequest
protected CosXmlResult	cosXmlResult
protected CosXmlResultListener	cosXmlResultListener
protected CosXmlServiceConfig	cosXmlServiceConfig
protected CryptoModuleBase	cryptoModuleBase
protected java.lang.String	key
protected boolean	manualCancel
protected boolean	manualPause
protected bolts.CancellationTokenSource	mTransferTaskCts
protected java.lang.String	region
protected CosXmlServiceException	serviceException
protected java.lang.String	taskId
protected TransferStateListener	transferStateListener
protected TransferTaskMetrics	transferTaskMetrics 任务运行的整体情况

方法概要

限定符和类型	方法和说明
void	cancel() 取消传输，如果是分片上传会调用 abort 接口
protected void	checking() 检查传输参数，并计算额外参数
protected abstract CosXmlResult	execute() 执行上传任务
protected abstract java.util.concurrent.Executor	executor()
CosXmlClientException	getClientException()
CosXmlServiceException	getServiceException()
TransferState	getTaskState()
TransferTaskMetrics	getTransferTaskMetrics() 获得本次传输的运行信息
protected boolean	isManualCanceled()
protected boolean	isManualPaused()
protected static void	loggerInfo(java.lang.String tag, java.lang.String taskId, java.lang.String format, java.lang.Object... params)
protected static void	loggerWarn(java.lang.String tag, java.lang.String taskId, java.lang.String format, java.lang.Object... params)
protected void	onTransferFailed(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)
protected void	onTransferInProgress()
protected void	onTransferPaused()
protected void	onTransferProgressChange(long complete, long target)
protected void	onTransferSuccess(CosXmlRequest cosXmlRequest, CosXmlResult cosXmlResult)
protected void	onTransferWaiting()
void	pause() 暂停传输
void	resume() 恢复传输
void	setCosXmlProgressListener(CosXmlProgressListener cosXmlProgressListener)
void	setCosXmlResultListener(CosXmlResultListener cosXmlResultListener)
void	setTransferStateListener(TransferStateListener transferStateListener)
protected void	start() 开始传输，内部调用
protected abstract java.lang.String	tag()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

region

protected java.lang.String region

bucket

protected java.lang.String bucket

key

protected java.lang.String key

cosXmlProgressListener

protected CosXmlProgressListener cosXmlProgressListener

cosXmlResultListener

protected CosXmlResultListener cosXmlResultListener

transferStateListener

protected TransferStateListener transferStateListener

cosXmlRequest

protected CosXmlRequest cosXmlRequest

cosXmlResult

protected CosXmlResult cosXmlResult

clientException

protected CosXmlClientException clientException

serviceException

protected CosXmlServiceException serviceException

transferTaskMetrics

protected volatile TransferTaskMetrics transferTaskMetrics

任务运行的整体情况

taskId

protected volatile java.lang.String taskId

manualPause

protected volatile boolean manualPause

manualCancel

protected volatile boolean manualCancel

mTransferTaskCts

protected volatile bolts.CancellationTokenSource mTransferTaskCts

cosXmlServiceConfig

protected CosXmlServiceConfig cosXmlServiceConfig

cosDirect

protected COSDirect cosDirect

cryptoModuleBase

protected CryptoModuleBase cryptoModuleBase

方法详细资料

setCosXmlResultListener

public void setCosXmlResultListener(CosXmlResultListener cosXmlResultListener)

setTransferStateListener

public void setTransferStateListener(TransferStateListener transferStateListener)

setCosXmlProgressListener

public void setCosXmlProgressListener(CosXmlProgressListener cosXmlProgressListener)

start

protected void start()

开始传输，内部调用

pause

public void pause()

暂停传输

resume

public void resume()

恢复传输

cancel

public void cancel()

取消传输，如果是分片上传会调用 abort 接口

getTransferTaskMetrics

public TransferTaskMetrics getTransferTaskMetrics()

获得本次传输的运行信息

返回:

TransferTaskMetrics

tag

protected abstract java.lang.String tag()

executor

protected abstract java.util.concurrent.Executor executor()

execute

protected abstract CosXmlResult execute()
                                 throws java.lang.Exception

执行上传任务

抛出:

java.lang.Exception

checking

protected void checking()
                 throws CosXmlClientException

检查传输参数，并计算额外参数

抛出:

CosXmlClientException

getTaskState

public TransferState getTaskState()

onTransferWaiting

protected void onTransferWaiting()

onTransferInProgress

protected void onTransferInProgress()

onTransferPaused

protected void onTransferPaused()

onTransferSuccess

protected void onTransferSuccess(CosXmlRequest cosXmlRequest,
                                 CosXmlResult cosXmlResult)

onTransferFailed

protected void onTransferFailed(CosXmlRequest cosXmlRequest,
                                CosXmlClientException clientException,
                                CosXmlServiceException serviceException)

onTransferProgressChange

protected void onTransferProgressChange(long complete,
                                        long target)

isManualPaused

protected boolean isManualPaused()

isManualCanceled

protected boolean isManualCanceled()

getClientException

public CosXmlClientException getClientException()

getServiceException

public CosXmlServiceException getServiceException()

loggerInfo

protected static void loggerInfo(java.lang.String tag,
                                 java.lang.String taskId,
                                 java.lang.String format,
                                 java.lang.Object... params)

loggerWarn

protected static void loggerWarn(java.lang.String tag,
                                 java.lang.String taskId,
                                 java.lang.String format,
                                 java.lang.Object... params)