类 COSXMLTask
- java.lang.Object
-
- com.tencent.cos.xml.transfer.COSXMLTask
-
- 直接已知子类:
COSXMLCopyTask,COSXMLDownloadTask,COSXMLUploadTask
public abstract class COSXMLTask extends java.lang.Object传输任务
-
-
嵌套类概要
嵌套类 修饰符和类型 类 说明 static interfaceCOSXMLTask.OnGetHttpTaskMetricsstatic interfaceCOSXMLTask.OnSignatureListener已过时。
-
字段概要
字段 修饰符和类型 字段 说明 protected java.lang.Stringbucket存储桶protected java.lang.StringcosPath对象cos路径protected com.tencent.cos.xml.listener.CosXmlProgressListenercosXmlProgressListener进度回调监听器protected com.tencent.cos.xml.listener.CosXmlResultListenercosXmlResultListener结果回调监听器protected CosXmlSimpleServicecosXmlServiceTencent Cloud COS服务protected com.tencent.qcloud.core.auth.QCloudCredentialProvidercredentialProvider请求的密钥提供器protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>headersheader 属性protected java.lang.Stringhostprotected InitMultipleUploadListenerinitMultipleUploadListener初始化分块上传监听器protected InitMultipleUploadListenerinternalInitMultipleUploadListenerprotected com.tencent.cos.xml.listener.CosXmlProgressListenerinternalProgressListenerprotected TransferStateListenerinternalStateListenerprotected java.util.concurrent.atomic.AtomicBooleanIS_EXIT退出:pause, cancel, failedprotected booleanisNeedMd5是否需要计算 MD5protected java.lang.ExceptionmException需要抛出的异常protected static com.tencent.cos.xml.transfer.TaskStateMonitormonitor状态监听器protected com.tencent.cos.xml.model.CosXmlResultmResult返回结果protected com.tencent.cos.xml.model.CosXmlRequest.RequestNetworkTypenetworkTypeprotected java.util.Set<java.lang.String>noSignHeaders不强制签名的header集合protected COSXMLTask.OnGetHttpTaskMetricsonGetHttpTaskMetrics获取 http metricsprotected COSXMLTask.OnSignatureListeneronSignatureListener直接提供签名串protected java.util.Map<java.lang.String,java.lang.String>queriesurl query 属性protected java.lang.Stringregion区域protected TransferStateListenertransferStateListener状态监听器protected java.util.TimerwaitTimeoutTimer
-
构造器概要
构造器 构造器 说明 COSXMLTask()
-
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 protected abstract com.tencent.cos.xml.model.CosXmlRequestbuildCOSXMLTaskRequest()构造COSXMLTask返回的Requestprotected abstract com.tencent.cos.xml.model.CosXmlResultbuildCOSXMLTaskResult(com.tencent.cos.xml.model.CosXmlResult sourceResult)构造COSXMLTask返回的Resultvoidcancel()取消任务voidcancel(boolean now)取消任务voidclearResultAndException()protected abstract voidencounterError(com.tencent.cos.xml.model.CosXmlRequest cosXmlRequest, com.tencent.cos.xml.exception.CosXmlClientException clientException, com.tencent.cos.xml.exception.CosXmlServiceException serviceException)protected java.util.Map<java.lang.String,java.lang.String>getCosXmlServiceConfigTrackParams()java.lang.ExceptiongetException()获取需要抛出的异常protected voidgetHttpMetrics(com.tencent.cos.xml.model.CosXmlRequest cosXmlRequest, java.lang.String requestName)com.tencent.cos.xml.model.CosXmlResultgetResult()获取返回结果TransferStategetTaskState()获取任务状态protected abstract voidinternalCancel(boolean now)protected abstract voidinternalCompleted()protected abstract voidinternalFailed()protected abstract voidinternalPause(boolean now)protected abstract voidinternalResume()voidpause()暂停任务,若是COSXMLUploadTask请调用COSXMLUploadTask.pauseSafely()接口来暂停。voidpause(boolean now)暂停任务,若是COSXMLUploadTask请调用COSXMLUploadTask.pauseSafely()接口来暂停。voidresume()恢复任务voidsetCosXmlProgressListener(com.tencent.cos.xml.listener.CosXmlProgressListener cosXmlProgressListener)设置进度回调监听器voidsetCosXmlResultListener(com.tencent.cos.xml.listener.CosXmlResultListener cosXmlResultListener)设置结果回调监听器protected voidsetCosXmlService(CosXmlSimpleService cosXmlService)设置COS服务voidsetInitMultipleUploadListener(InitMultipleUploadListener initMultipleUploadListener)设置初始化分块上传监听器voidsetOnGetHttpTaskMetrics(COSXMLTask.OnGetHttpTaskMetrics onGetHttpTaskMetrics)voidsetOnSignatureListener(COSXMLTask.OnSignatureListener onSignatureListener)voidsetTransferStateListener(TransferStateListener transferStateListener)设置状态监听器voidstartTimeoutTimer(long millisecond)protected voidupdateState(TransferState newTaskState, java.lang.Exception exception, com.tencent.cos.xml.model.CosXmlResult result, boolean isInit)更新状态 waiting: 准备状态, 任何状态都可以转为它, task 准备执行.
-
-
-
字段详细资料
-
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 com.tencent.cos.xml.model.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 属性
-
noSignHeaders
protected java.util.Set<java.lang.String> noSignHeaders
不强制签名的header集合
-
isNeedMd5
protected boolean isNeedMd5
是否需要计算 MD5
-
networkType
protected com.tencent.cos.xml.model.CosXmlRequest.RequestNetworkType networkType
-
host
protected java.lang.String host
-
credentialProvider
protected com.tencent.qcloud.core.auth.QCloudCredentialProvider credentialProvider
请求的密钥提供器
-
cosXmlProgressListener
protected com.tencent.cos.xml.listener.CosXmlProgressListener cosXmlProgressListener
进度回调监听器
-
cosXmlResultListener
protected com.tencent.cos.xml.listener.CosXmlResultListener cosXmlResultListener
结果回调监听器
-
transferStateListener
protected TransferStateListener transferStateListener
状态监听器
-
initMultipleUploadListener
protected InitMultipleUploadListener initMultipleUploadListener
初始化分块上传监听器
-
internalStateListener
protected TransferStateListener internalStateListener
-
internalProgressListener
protected com.tencent.cos.xml.listener.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
-
-
方法详细资料
-
setCosXmlService
protected void setCosXmlService(CosXmlSimpleService cosXmlService)
设置COS服务- 参数:
cosXmlService- COS服务类
-
setCosXmlProgressListener
public void setCosXmlProgressListener(com.tencent.cos.xml.listener.CosXmlProgressListener cosXmlProgressListener)
设置进度回调监听器- 参数:
cosXmlProgressListener- 进度回调监听器
-
setCosXmlResultListener
public void setCosXmlResultListener(com.tencent.cos.xml.listener.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(com.tencent.cos.xml.model.CosXmlRequest cosXmlRequest, java.lang.String requestName)
-
startTimeoutTimer
public void startTimeoutTimer(long millisecond)
-
internalCompleted
protected abstract void internalCompleted()
-
internalFailed
protected abstract void internalFailed()
-
internalPause
protected abstract void internalPause(boolean now)
-
internalCancel
protected abstract void internalCancel(boolean now)
-
internalResume
protected abstract void internalResume()
-
encounterError
protected abstract void encounterError(@Nullable com.tencent.cos.xml.model.CosXmlRequest cosXmlRequest, com.tencent.cos.xml.exception.CosXmlClientException clientException, com.tencent.cos.xml.exception.CosXmlServiceException serviceException)
-
pause
public void pause()
暂停任务,若是COSXMLUploadTask请调用COSXMLUploadTask.pauseSafely()接口来暂停。
-
pause
public void pause(boolean now)
暂停任务,若是COSXMLUploadTask请调用COSXMLUploadTask.pauseSafely()接口来暂停。
-
cancel
public void cancel()
取消任务
-
cancel
public void cancel(boolean now)
取消任务
-
resume
public void resume()
恢复任务
-
getTaskState
public TransferState getTaskState()
获取任务状态- 返回:
- 任务状态
-
getResult
public com.tencent.cos.xml.model.CosXmlResult getResult()
获取返回结果- 返回:
- 返回结果
-
getException
public java.lang.Exception getException()
获取需要抛出的异常- 返回:
- 需要抛出的异常
-
buildCOSXMLTaskRequest
protected abstract com.tencent.cos.xml.model.CosXmlRequest buildCOSXMLTaskRequest()
构造COSXMLTask返回的Request- 返回:
- COSXMLTask返回的Request
-
clearResultAndException
public void clearResultAndException()
-
buildCOSXMLTaskResult
protected abstract com.tencent.cos.xml.model.CosXmlResult buildCOSXMLTaskResult(com.tencent.cos.xml.model.CosXmlResult sourceResult)
构造COSXMLTask返回的Result- 参数:
sourceResult- 原始CosXmlResult- 返回:
- Task返回的Result
-
updateState
protected void updateState(TransferState newTaskState, java.lang.Exception exception, com.tencent.cos.xml.model.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
-
getCosXmlServiceConfigTrackParams
protected java.util.Map<java.lang.String,java.lang.String> getCosXmlServiceConfigTrackParams()
-
-