com.tencent.cos.xml

类 CosXmlBaseService

java.lang.Object

com.tencent.cos.xml.CosXmlBaseService

所有已实现的接口:

BaseCosXml

直接已知子类:

CosXmlSimpleService

public class CosXmlBaseService
extends java.lang.Object
implements BaseCosXml

提供用于访问Tencent Cloud COS服务的基础服务类。
在调用 COS 服务前，都必须初始化一个该类的对象。

更详细的使用方式请参考：入门文档

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	appCachePath
static java.lang.String	BRIDGE 桥接来源
protected QCloudHttpClient	client
protected CosXmlServiceConfig	config
protected QCloudCredentialProvider	credentialProvider
static boolean	IS_CLOSE_BEACON 是否关闭灯塔上报
protected java.lang.String	requestDomain
protected QCloudSelfSigner	selfSigner
protected java.lang.String	signerType
protected java.lang.String	tag

构造器概要

构造器

构造器和说明
CosXmlBaseService(android.content.Context context, CosXmlServiceConfig configuration) cos android SDK 服务
CosXmlBaseService(android.content.Context context, CosXmlServiceConfig configuration, QCloudCredentialProvider qCloudCredentialProvider) cos android SDK 服务
CosXmlBaseService(android.content.Context context, CosXmlServiceConfig configuration, QCloudSelfSigner selfSigner) cos android SDK 服务
CosXmlBaseService(android.content.Context context, CosXmlServiceConfig configuration, QCloudSigner qCloudSigner) cos android SDK 服务

方法概要

限定符和类型	方法和说明
void	addCustomerDNS(java.lang.String domainName, java.lang.String[] ipList) 自定义 DNS 解析
void	addCustomerDNSFetch(QCloudHttpClient.QCloudDnsFetch dnsFetch) 添加自定义 DNS 解析器 支持添加多个，会顺序解析获取
void	addVerifiedHost(java.lang.String hostName) 已过时。
BasePutObjectResult	basePutObject(BasePutObjectRequest request) 基础简单上传的同步方法.
void	basePutObjectAsync(BasePutObjectRequest request, CosXmlResultListener cosXmlResultListener) 基础简单上传的异步方法.
protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> QCloudHttpRequest	buildHttpRequest(T1 cosXmlRequest, T2 cosXmlResult) 构建请求 Header 数据优先级：request、config、默认
protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> boolean	buildHttpRequestBodyConverter(T1 cosXmlRequest, T2 cosXmlResult, QCloudHttpRequest.Builder<T2> httpRequestBuilder)
void	cancel(CosXmlRequest cosXmlRequest) 取消请求任务.
void	cancelAll() 取消所有的请求任务.
protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> T2	execute(T1 cosXmlRequest, T2 cosXmlResult) 同步执行
java.lang.String	getAccessUrl(CosXmlRequest cosXmlRequest) 获取请求的访问地址
java.lang.String	getAppid() 已过时。
CosXmlServiceConfig	getConfig()
QCloudCredentialProvider	getCredentialProvider()
java.io.File[]	getLogFiles(int limit) 获取 SDK 日志信息
GetObjectResult	getObject(GetObjectRequest request) 获取 COS 对象的同步方法.
byte[]	getObject(java.lang.String bucketName, java.lang.String objectName) 将 COS 对象下载为字节数组 详细介绍，请查看:BaseCosXml.getObject(String, String)
void	getObjectAsync(GetObjectRequest request, CosXmlResultListener cosXmlResultListener) 获取 COS 对象的异步方法.
java.lang.String	getObjectUrl(java.lang.String bucket, java.lang.String region, java.lang.String key) 获取对象的 url 地址
java.lang.String	getPresignedURL(CosXmlRequest cosXmlRequest) 获取预签名文件URL
java.lang.String	getRegion() 已过时。
java.lang.String	getRegion(CosXmlRequest cosXmlRequest) 已过时。
protected java.lang.String	getRequestHost(CosXmlRequest request)
void	release() 释放所有的请求.
protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> void	schedule(T1 cosXmlRequest, T2 cosXmlResult, CosXmlResultListener cosXmlResultListener) 异步执行
protected <T1 extends CosXmlRequest> void	setCopySource(T1 cosXmlRequest)
void	setDomain(java.lang.String domain) 设置除 get service 请求外其他所有请求的域名
void	setNetworkClient(CosXmlServiceConfig configuration)
protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> void	setProgressListener(T1 cosXmlRequest, HttpTask<T2> httpTask, boolean isSchedule)
protected java.lang.String	signerTypeCompat(java.lang.String signerType, CosXmlRequest cosXmlRequest) 兼容某些request的signerType（比如SensitiveContentRecognitionRequest应该是cos 而不是ci）
UploadPartResult	uploadPart(UploadPartRequest request) 上传一个对象某个分片块的同步方法.
void	uploadPartAsync(UploadPartRequest request, CosXmlResultListener cosXmlResultListener) 上传一个对象某个分片块的异步方法.

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

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

字段详细资料

IS_CLOSE_BEACON

public static boolean IS_CLOSE_BEACON

是否关闭灯塔上报

BRIDGE

public static java.lang.String BRIDGE

桥接来源

client

protected volatile QCloudHttpClient client

credentialProvider

protected QCloudCredentialProvider credentialProvider

tag

protected java.lang.String tag

signerType

protected java.lang.String signerType

config

protected CosXmlServiceConfig config

appCachePath

public static java.lang.String appCachePath

requestDomain

protected java.lang.String requestDomain

selfSigner

protected QCloudSelfSigner selfSigner

构造器详细资料

CosXmlBaseService

public CosXmlBaseService(android.content.Context context,
                         CosXmlServiceConfig configuration,
                         QCloudCredentialProvider qCloudCredentialProvider)

cos android SDK 服务

参数:

context - Application 上下文Application

configuration - cos android SDK 服务配置CosXmlServiceConfig

qCloudCredentialProvider - cos android SDK 证书提供者 QCloudCredentialProvider

CosXmlBaseService

public CosXmlBaseService(android.content.Context context,
                         CosXmlServiceConfig configuration)

cos android SDK 服务

参数:

context - Application 上下文Application

configuration - cos android SDK 服务配置CosXmlServiceConfig

CosXmlBaseService

public CosXmlBaseService(android.content.Context context,
                         CosXmlServiceConfig configuration,
                         QCloudSigner qCloudSigner)

cos android SDK 服务

参数:

context - Application 上下文Application

configuration - cos android SDK 服务配置 CosXmlServiceConfig

qCloudSigner - cos android SDK 签名提供者 QCloudSigner

CosXmlBaseService

public CosXmlBaseService(android.content.Context context,
                         CosXmlServiceConfig configuration,
                         QCloudSelfSigner selfSigner)

cos android SDK 服务

参数:

context - Application 上下文Application

configuration - cos android SDK 服务配置 CosXmlServiceConfig

selfSigner - cos android SDK 签名提供者 QCloudSelfSigner

方法详细资料

getCredentialProvider

public QCloudCredentialProvider getCredentialProvider()

signerTypeCompat

protected java.lang.String signerTypeCompat(java.lang.String signerType,
                                            CosXmlRequest cosXmlRequest)

兼容某些request的signerType（比如SensitiveContentRecognitionRequest应该是cos 而不是ci）

返回:

新的正确的signerType

setNetworkClient

public void setNetworkClient(CosXmlServiceConfig configuration)

addCustomerDNS

public void addCustomerDNS(java.lang.String domainName,
                           java.lang.String[] ipList)
                    throws CosXmlClientException

自定义 DNS 解析

参数:

domainName - dns 解析的 domain

ipList - 解析的 ip 地址列表

抛出:

CosXmlClientException - 客户端异常

addCustomerDNSFetch

public void addCustomerDNSFetch(@NonNull
                                QCloudHttpClient.QCloudDnsFetch dnsFetch)

添加自定义 DNS 解析器 支持添加多个，会顺序解析获取

参数:

dnsFetch - DNS 解析器

addVerifiedHost

@Deprecated
public void addVerifiedHost(java.lang.String hostName)

已过时。

setDomain

public void setDomain(java.lang.String domain)

设置除 get service 请求外其他所有请求的域名

参数:

domain - 域名

getRequestHost

protected java.lang.String getRequestHost(CosXmlRequest request)
                                   throws CosXmlClientException

抛出:

CosXmlClientException

buildHttpRequest

protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> QCloudHttpRequest buildHttpRequest(T1 cosXmlRequest,
                                                                                                T2 cosXmlResult)
                                                                                         throws CosXmlClientException

构建请求 Header 数据优先级：request、config、默认

抛出:

CosXmlClientException

buildHttpRequestBodyConverter

protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> boolean buildHttpRequestBodyConverter(T1 cosXmlRequest,
                                                                                                   T2 cosXmlResult,
                                                                                                   QCloudHttpRequest.Builder<T2> httpRequestBuilder)

execute

protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> T2 execute(T1 cosXmlRequest,
                                                                        T2 cosXmlResult)
                                                                 throws CosXmlClientException,
                                                                        CosXmlServiceException

同步执行

抛出:

CosXmlClientException

CosXmlServiceException

schedule

protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> void schedule(T1 cosXmlRequest,
                                                                           T2 cosXmlResult,
                                                                           CosXmlResultListener cosXmlResultListener)

异步执行

setCopySource

protected <T1 extends CosXmlRequest> void setCopySource(T1 cosXmlRequest)
                                                 throws CosXmlClientException

抛出:

CosXmlClientException

setProgressListener

protected <T1 extends CosXmlRequest,T2 extends CosXmlResult> void setProgressListener(T1 cosXmlRequest,
                                                                                      HttpTask<T2> httpTask,
                                                                                      boolean isSchedule)

getAccessUrl

public java.lang.String getAccessUrl(CosXmlRequest cosXmlRequest)

获取请求的访问地址

参数:

cosXmlRequest - 请求

返回:

String 访问地址

getPresignedURL

public java.lang.String getPresignedURL(CosXmlRequest cosXmlRequest)
                                 throws CosXmlClientException

获取预签名文件URL

参数:

cosXmlRequest - 请求

返回:

String 签名 URL

抛出:

CosXmlClientException - 客户端异常

getObject

public GetObjectResult getObject(GetObjectRequest request)
                          throws CosXmlClientException,
                                 CosXmlServiceException

获取 COS 对象的同步方法.

详细介绍，请查看:BaseCosXml.getObject(GetObjectRequest)

指定者:

getObject 在接口中 BaseCosXml

参数:

request - 获取 COS 对象的请求 GetObjectRequest

返回:

获取 COS 对象的请求返回的结果 GetObjectResult

抛出:

CosXmlClientException - 客户端异常

CosXmlServiceException - 服务端异常

getObjectAsync

public void getObjectAsync(GetObjectRequest request,
                           CosXmlResultListener cosXmlResultListener)

获取 COS 对象的异步方法.

详细介绍，请查看:BaseCosXml.getObjectAsync(GetObjectRequest, CosXmlResultListener)

指定者:

getObjectAsync 在接口中 BaseCosXml

参数:

request - 获取 COS 对象的请求 GetObjectRequest

cosXmlResultListener - 请求回调结果 CosXmlResultListener

getObject

public byte[] getObject(java.lang.String bucketName,
                        java.lang.String objectName)
                 throws CosXmlClientException,
                        CosXmlServiceException

将 COS 对象下载为字节数组

详细介绍，请查看:BaseCosXml.getObject(String, String)

指定者:

getObject 在接口中 BaseCosXml

参数:

bucketName - 存储桶名称

objectName - 对象远端路径，即存储到 COS 上的绝对路径

返回:

对象的字节数据

抛出:

CosXmlClientException - 客户端异常

CosXmlServiceException - 服务端异常

basePutObject

public BasePutObjectResult basePutObject(BasePutObjectRequest request)
                                  throws CosXmlClientException,
                                         CosXmlServiceException

基础简单上传的同步方法.

详细介绍，请查看:BaseCosXml.basePutObject(BasePutObjectRequest)

指定者:

basePutObject 在接口中 BaseCosXml

参数:

request - 简单上传请求 BasePutObjectRequest

返回:

简单上传请求返回的结果 BasePutObjectResult

抛出:

CosXmlClientException - 客户端异常

CosXmlServiceException - 服务端异常

basePutObjectAsync

public void basePutObjectAsync(BasePutObjectRequest request,
                               CosXmlResultListener cosXmlResultListener)

基础简单上传的异步方法.

详细介绍，请查看:BaseCosXml.basePutObjectAsync(BasePutObjectRequest, CosXmlResultListener)

指定者:

basePutObjectAsync 在接口中 BaseCosXml

参数:

request - 简单上传请求 BasePutObjectRequest

cosXmlResultListener - 请求回调结果 CosXmlResultListener

uploadPart

public UploadPartResult uploadPart(UploadPartRequest request)
                            throws CosXmlClientException,
                                   CosXmlServiceException

上传一个对象某个分片块的同步方法.

详细介绍，请查看:BaseCosXml.uploadPart(UploadPartRequest)

指定者:

uploadPart 在接口中 BaseCosXml

参数:

request - 上传一个对象某个分块请求 UploadPartRequest

返回:

上传一个对象某个分块请求返回的结果 UploadPartResult

抛出:

CosXmlClientException - 客户端异常

CosXmlServiceException - 服务端异常

uploadPartAsync

public void uploadPartAsync(UploadPartRequest request,
                            CosXmlResultListener cosXmlResultListener)

上传一个对象某个分片块的异步方法.

详细介绍，请查看:BaseCosXml.uploadPartAsync(UploadPartRequest, CosXmlResultListener)

指定者:

uploadPartAsync 在接口中 BaseCosXml

参数:

request - 上传某个分块请求 UploadPartRequest

cosXmlResultListener - 请求回调结果 CosXmlResultListener

getObjectUrl

public java.lang.String getObjectUrl(java.lang.String bucket,
                                     java.lang.String region,
                                     java.lang.String key)

从接口复制的说明: BaseCosXml

获取对象的 url 地址

指定者:

getObjectUrl 在接口中 BaseCosXml

返回:

对象的 url 地址

cancel

public void cancel(CosXmlRequest cosXmlRequest)

取消请求任务. 详细介绍，请查看:BaseCosXml.cancel(CosXmlRequest)

指定者:

cancel 在接口中 BaseCosXml

参数:

cosXmlRequest - 请求request CosXmlRequest

cancelAll

public void cancelAll()

取消所有的请求任务. 详细介绍，请查看:BaseCosXml.cancelAll()

指定者:

cancelAll 在接口中 BaseCosXml

release

public void release()

释放所有的请求. 详细介绍，请查看:BaseCosXml.release()

指定者:

release 在接口中 BaseCosXml

getAppid

@Deprecated
public java.lang.String getAppid()

已过时。

getRegion

@Deprecated
public java.lang.String getRegion()

已过时。

getRegion

@Deprecated
public java.lang.String getRegion(CosXmlRequest cosXmlRequest)

已过时。

getConfig

public CosXmlServiceConfig getConfig()

getLogFiles

public java.io.File[] getLogFiles(int limit)

获取 SDK 日志信息