com.tencent.cos.xml.transfer

类 COSXMLTask

java.lang.Object

com.tencent.cos.xml.transfer.COSXMLTask

直接已知子类:

COSXMLCopyTask, COSXMLDownloadTask, COSXMLUploadTask

public abstract class COSXMLTask
extends java.lang.Object

传输任务

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	COSXMLTask.OnGetHttpTaskMetrics
static interface	COSXMLTask.OnSignatureListener 已过时。

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	bucket 存储桶
protected java.lang.String	cosPath 对象cos路径
protected CosXmlProgressListener	cosXmlProgressListener 进度回调监听器
protected CosXmlResultListener	cosXmlResultListener 结果回调监听器
protected CosXmlSimpleService	cosXmlService Tencent Cloud COS服务
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	headers header 属性
protected InitMultipleUploadListener	initMultipleUploadListener 初始化分块上传监听器
protected InitMultipleUploadListener	internalInitMultipleUploadListener
protected CosXmlProgressListener	internalProgressListener
protected TransferStateListener	internalStateListener
protected java.util.concurrent.atomic.AtomicBoolean	IS_EXIT 退出：pause, cancel, failed
protected boolean	isNeedMd5 是否需要计算 MD5
protected java.lang.Exception	mException 需要抛出的异常
protected static com.tencent.cos.xml.transfer.TaskStateMonitor	monitor 状态监听器
protected CosXmlResult	mResult 返回结果
protected COSXMLTask.OnGetHttpTaskMetrics	onGetHttpTaskMetrics 获取 http metrics
protected COSXMLTask.OnSignatureListener	onSignatureListener 直接提供签名串
protected java.util.Map<java.lang.String,java.lang.String>	queries url query 属性
protected java.lang.String	region 区域
protected TransferStateListener	transferStateListener 状态监听器
protected java.util.Timer	waitTimeoutTimer

构造器概要

构造器

构造器和说明
COSXMLTask()

方法概要

限定符和类型	方法和说明
protected abstract CosXmlRequest	buildCOSXMLTaskRequest() 构造COSXMLTask返回的Request
protected abstract CosXmlResult	buildCOSXMLTaskResult(CosXmlResult sourceResult) 构造COSXMLTask返回的Result
void	cancel() 取消任务
void	clearResultAndException()
protected abstract void	encounterError(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)
java.lang.Exception	getException() 获取需要抛出的异常
protected void	getHttpMetrics(CosXmlRequest cosXmlRequest, java.lang.String requestName)
CosXmlResult	getResult() 获取返回结果
TransferState	getTaskState() 获取任务状态
protected void	internalCancel()
protected void	internalCompleted()
protected void	internalFailed()
protected void	internalPause()
protected void	internalResume()
void	pause() 暂停任务，若是 COSXMLUploadTask 请调用 COSXMLUploadTask.pauseSafely() 接口来暂停。
void	resume() 恢复任务
void	setCosXmlProgressListener(CosXmlProgressListener cosXmlProgressListener) 设置进度回调监听器
void	setCosXmlResultListener(CosXmlResultListener cosXmlResultListener) 设置结果回调监听器
protected void	setCosXmlService(CosXmlSimpleService cosXmlService) 设置COS服务
void	setInitMultipleUploadListener(InitMultipleUploadListener initMultipleUploadListener) 设置初始化分块上传监听器
void	setOnGetHttpTaskMetrics(COSXMLTask.OnGetHttpTaskMetrics onGetHttpTaskMetrics)
void	setOnSignatureListener(COSXMLTask.OnSignatureListener onSignatureListener)
void	setTransferStateListener(TransferStateListener transferStateListener) 设置状态监听器
void	startTimeoutTimer(long millisecond)
protected void	updateState(TransferState newTaskState, java.lang.Exception exception, CosXmlResult result, boolean isInit) 更新状态 waiting: 准备状态, 任何状态都可以转为它, task 准备执行.

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

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

字段详细资料

monitor

protected static com.tencent.cos.xml.transfer.TaskStateMonitor monitor

状态监听器

cosXmlService

protected CosXmlSimpleService cosXmlService

Tencent Cloud COS服务

region

protected java.lang.String region

区域

bucket

protected java.lang.String bucket

存储桶

cosPath

protected java.lang.String cosPath

对象cos路径

mResult

protected CosXmlResult mResult

返回结果

mException

protected java.lang.Exception mException

需要抛出的异常

queries

protected java.util.Map<java.lang.String,java.lang.String> queries

url query 属性

headers

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers

header 属性

isNeedMd5

protected boolean isNeedMd5

是否需要计算 MD5

cosXmlProgressListener

protected CosXmlProgressListener cosXmlProgressListener

进度回调监听器

cosXmlResultListener

protected CosXmlResultListener cosXmlResultListener

结果回调监听器

transferStateListener

protected TransferStateListener transferStateListener

状态监听器

initMultipleUploadListener

protected InitMultipleUploadListener initMultipleUploadListener

初始化分块上传监听器

internalStateListener

protected TransferStateListener internalStateListener

internalProgressListener

protected CosXmlProgressListener internalProgressListener

internalInitMultipleUploadListener

protected InitMultipleUploadListener internalInitMultipleUploadListener

IS_EXIT

protected java.util.concurrent.atomic.AtomicBoolean IS_EXIT

退出：pause, cancel, failed

onSignatureListener

protected COSXMLTask.OnSignatureListener onSignatureListener

直接提供签名串

onGetHttpTaskMetrics

protected COSXMLTask.OnGetHttpTaskMetrics onGetHttpTaskMetrics

获取 http metrics

waitTimeoutTimer

protected java.util.Timer waitTimeoutTimer

构造器详细资料

COSXMLTask

public COSXMLTask()

方法详细资料

setCosXmlService

protected void setCosXmlService(CosXmlSimpleService cosXmlService)

设置COS服务

参数:

cosXmlService - COS服务类

setCosXmlProgressListener

public void setCosXmlProgressListener(CosXmlProgressListener cosXmlProgressListener)

设置进度回调监听器

参数:

cosXmlProgressListener - 进度回调监听器

setCosXmlResultListener

public void setCosXmlResultListener(CosXmlResultListener cosXmlResultListener)

设置结果回调监听器

参数:

cosXmlResultListener - 结果回调监听器

setTransferStateListener

public void setTransferStateListener(TransferStateListener transferStateListener)

设置状态监听器

参数:

transferStateListener - 状态监听器

setInitMultipleUploadListener

public void setInitMultipleUploadListener(InitMultipleUploadListener initMultipleUploadListener)

设置初始化分块上传监听器

参数:

initMultipleUploadListener - 初始化分块上传监听器

setOnSignatureListener

public void setOnSignatureListener(COSXMLTask.OnSignatureListener onSignatureListener)

setOnGetHttpTaskMetrics

public void setOnGetHttpTaskMetrics(COSXMLTask.OnGetHttpTaskMetrics onGetHttpTaskMetrics)

getHttpMetrics

protected void getHttpMetrics(CosXmlRequest cosXmlRequest,
                              java.lang.String requestName)

startTimeoutTimer

public void startTimeoutTimer(long millisecond)

internalCompleted

protected void internalCompleted()

internalFailed

protected void internalFailed()

internalPause

protected void internalPause()

internalCancel

protected void internalCancel()

internalResume

protected void internalResume()

encounterError

protected abstract void encounterError(@Nullable
                                       CosXmlRequest cosXmlRequest,
                                       CosXmlClientException clientException,
                                       CosXmlServiceException serviceException)

pause

public void pause()

暂停任务，若是 COSXMLUploadTask 请调用 COSXMLUploadTask.pauseSafely() 接口来暂停。

cancel

public void cancel()

取消任务

resume

public void resume()

恢复任务

getTaskState

public TransferState getTaskState()

获取任务状态

返回:

任务状态

getResult

public CosXmlResult getResult()

获取返回结果

返回:

返回结果

getException

public java.lang.Exception getException()

获取需要抛出的异常

返回:

需要抛出的异常

buildCOSXMLTaskRequest

protected abstract CosXmlRequest buildCOSXMLTaskRequest()

构造COSXMLTask返回的Request

返回:

COSXMLTask返回的Request

clearResultAndException

public void clearResultAndException()

buildCOSXMLTaskResult

protected abstract CosXmlResult buildCOSXMLTaskResult(CosXmlResult sourceResult)

构造COSXMLTask返回的Result

参数:

sourceResult - 原始CosXmlResult

返回:

Task返回的Result

updateState

protected void updateState(TransferState newTaskState,
                           java.lang.Exception exception,
                           CosXmlResult result,
                           boolean isInit)

更新状态 waiting: 准备状态, 任何状态都可以转为它, task 准备执行. in_progress: 运行状态，只能由waiting转为它, task 执行中. complete: 完成状态，只能由 in_progress状态转为它, task 执行完. failed: 失败状态，只能由waiting、in_progress状态转为它, task 执行失败. pause: 暂停状态，只能由waiting、in_progress状态转为它, task 暂停执行. cancel: 取消状态，除了complete之外，任何状态都可以转为它, task 取消，并释放资源. resume_waiting: 恢复状态，只能由 pause、failed. 这是一个特殊的状态，会直接过渡到waiting, task 恢复执行. 此方法中 newTaskState 不能是 waiting

参数:

newTaskState - new state for operating