com.volcengine.service

类 BaseServiceImpl

java.lang.Object

com.volcengine.service.BaseServiceImpl

所有已实现的接口:

IBaseService

直接已知子类:

ACEPTrait, AdBlockerServiceImpl, BillingServiceImpl, BusinessSecurityServiceImpl, CDNServiceImpl, CloudTrailServiceImpl, CmsApiServiceImpl, CmsPlatformServiceImpl, ContentSecurityServiceImpl, ExportReportsServiceImpl, GameProtectServiceImpl, IamServiceImpl, ImageXServiceImpl, ImagexTrait, ImpServiceImpl, ImTrait, IPaasServiceImpl, KmsServiceImpl, LivesaasServiceImpl, LiveServiceImpl, LiveTrait, LiveTrait, LogServiceImpl, MaasServiceImpl, MaasServiceImpl, MonitorServiceImpl, RtcServiceImpl, SearchServiceImpl, SecuritySourceServiceImpl, SmsServiceImpl, StreamConsumerServiceImpl, StreamServiceImpl, STSServiceImpl, TLSHttpUtil, TranslateServiceImpl, VEditServiceImpl, VideoAIoTServiceImpl, VikingDBService, VisualServiceImpl, VmsServiceImpl, VodServiceImpl

public abstract class BaseServiceImpl
extends Object
implements IBaseService

字段概要

字段

限定符和类型	字段和说明
protected Map<String,ApiInfo>	apiInfoList
protected Credentials	credentials
protected ISignerV4	ISigner
protected ServiceInfo	serviceInfo

构造器概要

构造器

构造器和说明
BaseServiceImpl(ServiceInfo info, org.apache.http.HttpHost proxy, Map<String,ApiInfo> apiInfoList)
BaseServiceImpl(ServiceInfo info, Map<String,ApiInfo> apiInfoList)

方法概要

限定符和类型	方法和说明
void	destroy() Free monitor thread
String	getAccessKey() Gets access key.
Map<String,ApiInfo>	getApiInfoList()
org.apache.http.client.HttpClient	getHttpClient()
ISignerV4	getISigner()
String	getRegion() Gets region.
String	getSecretKey() Gets secret key.
ServiceInfo	getServiceInfo()
String	getSessionToken() Gets session token.
String	getSignUrl(String api, List<org.apache.http.NameValuePair> params) Gets sign url.
RawResponse	json(String api, List<org.apache.http.NameValuePair> params, String body) Json raw response.
protected RawResponse	makeRequest(String api, SignableRequest request)
RawResponse	post(String api, List<org.apache.http.NameValuePair> query, List<org.apache.http.NameValuePair> form) Post raw response.
org.apache.http.HttpResponse	postDataWithResponse(String url, byte[] data, Map<String,String> headers)
RawResponse	postFileMultiPart(String api, List<org.apache.http.NameValuePair> fromData, String dataName, String fileName, byte[] data)
protected SignableRequest	prepareRequest(String api, List<org.apache.http.NameValuePair> params)
RawResponse	proto(String api, List<org.apache.http.NameValuePair> params, Map<String,String> header, byte[] body, String compressType)
boolean	put(String url, String filePath, Map<String,String> headers) Put boolean.
boolean	putData(String url, byte[] data, Map<String,String> headers) Put binary data.
boolean	putData(String url, InputStream inputStream, Map<String,String> headers)
org.apache.http.HttpResponse	putDataWithResponse(String url, byte[] data, Map<String,String> headers)
org.apache.http.HttpResponse	putDataWithResponse(String url, InputStream inputStream, Map<String,String> headers)
RawResponse	query(String api, List<org.apache.http.NameValuePair> params) Query raw response.
void	setAccessKey(String accessKey) Sets access key.
void	setClientNoReuse() Sets client no reuse.
void	setConnectionTimeout(int connectionTimeout) Sets connection timeout.
void	setHost(String host) Sets host.
void	setHttpClient(org.apache.http.client.HttpClient httpClient) Sets http client.
void	setRegion(String region) Sets region.
void	setScheme(String scheme) Sets scheme.
void	setSecretKey(String secretKey) Sets secret key.
void	setServiceInfo(ServiceInfo serviceInfo) Sets service info.
void	setSessionToken(String sessionToken) Sets session token.
void	setSocketTimeout(int socketTimeout) Sets socket timeout.
SecurityToken2	signSts2(Policy inlinePolicy, long expire) Sign by sts2.

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

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

字段详细资料

serviceInfo

protected ServiceInfo serviceInfo

apiInfoList

protected Map<String,ApiInfo> apiInfoList

ISigner

protected ISignerV4 ISigner

credentials

protected Credentials credentials

构造器详细资料

BaseServiceImpl

public BaseServiceImpl(ServiceInfo info,
                       org.apache.http.HttpHost proxy,
                       Map<String,ApiInfo> apiInfoList)

BaseServiceImpl

public BaseServiceImpl(ServiceInfo info,
                       Map<String,ApiInfo> apiInfoList)

方法详细资料

destroy

public void destroy()

从接口复制的说明: IBaseService

Free monitor thread

指定者:

destroy 在接口中 IBaseService

getSignUrl

public String getSignUrl(String api,
                         List<org.apache.http.NameValuePair> params)
                  throws Exception

从接口复制的说明: IBaseService

Gets sign url.

指定者:

getSignUrl 在接口中 IBaseService

参数:

api - the api

params - the params

返回:

the sign url

抛出:

Exception - the exception

query

public RawResponse query(String api,
                         List<org.apache.http.NameValuePair> params)

从接口复制的说明: IBaseService

Query raw response.

指定者:

query 在接口中 IBaseService

参数:

api - the api

params - the params

返回:

the raw response

put

public boolean put(String url,
                   String filePath,
                   Map<String,String> headers)

从接口复制的说明: IBaseService

Put boolean.

指定者:

put 在接口中 IBaseService

参数:

url - the url

filePath - the file path

headers - the headers

返回:

the boolean

putData

public boolean putData(String url,
                       byte[] data,
                       Map<String,String> headers)

从接口复制的说明: IBaseService

Put binary data.

指定者:

putData 在接口中 IBaseService

参数:

url - target url

data - binary data

headers - http headers

返回:

put status

putDataWithResponse

public org.apache.http.HttpResponse putDataWithResponse(String url,
                                                        byte[] data,
                                                        Map<String,String> headers)

putData

public boolean putData(String url,
                       InputStream inputStream,
                       Map<String,String> headers)

postDataWithResponse

public org.apache.http.HttpResponse postDataWithResponse(String url,
                                                         byte[] data,
                                                         Map<String,String> headers)

putDataWithResponse

public org.apache.http.HttpResponse putDataWithResponse(String url,
                                                        InputStream inputStream,
                                                        Map<String,String> headers)

json

public RawResponse json(String api,
                        List<org.apache.http.NameValuePair> params,
                        String body)

从接口复制的说明: IBaseService

Json raw response.

指定者:

json 在接口中 IBaseService

参数:

api - the api

params - the params

body - the body

返回:

the raw response

post

public RawResponse post(String api,
                        List<org.apache.http.NameValuePair> query,
                        List<org.apache.http.NameValuePair> form)

从接口复制的说明: IBaseService

Post raw response.

指定者:

post 在接口中 IBaseService

参数:

api - the api

query - the params

form - the form

返回:

the raw response

postFileMultiPart

public RawResponse postFileMultiPart(String api,
                                     List<org.apache.http.NameValuePair> fromData,
                                     String dataName,
                                     String fileName,
                                     byte[] data)

makeRequest

protected RawResponse makeRequest(String api,
                                  SignableRequest request)

prepareRequest

protected SignableRequest prepareRequest(String api,
                                         List<org.apache.http.NameValuePair> params)

setClientNoReuse

public void setClientNoReuse()

从接口复制的说明: IBaseService

Sets client no reuse.

指定者:

setClientNoReuse 在接口中 IBaseService

getAccessKey

public String getAccessKey()

从接口复制的说明: IBaseService

Gets access key.

指定者:

getAccessKey 在接口中 IBaseService

返回:

the access key

setAccessKey

public void setAccessKey(String accessKey)

从接口复制的说明: IBaseService

Sets access key.

指定者:

setAccessKey 在接口中 IBaseService

参数:

accessKey - the access key

getSecretKey

public String getSecretKey()

从接口复制的说明: IBaseService

Gets secret key.

指定者:

getSecretKey 在接口中 IBaseService

返回:

the secret key

setSecretKey

public void setSecretKey(String secretKey)

从接口复制的说明: IBaseService

Sets secret key.

指定者:

setSecretKey 在接口中 IBaseService

参数:

secretKey - the secret key

getSessionToken

public String getSessionToken()

从接口复制的说明: IBaseService

Gets session token.

指定者:

getSessionToken 在接口中 IBaseService

返回:

the session token

setSessionToken

public void setSessionToken(String sessionToken)

从接口复制的说明: IBaseService

Sets session token.

指定者:

setSessionToken 在接口中 IBaseService

参数:

sessionToken - the session token

setRegion

public void setRegion(String region)

从接口复制的说明: IBaseService

Sets region.

指定者:

setRegion 在接口中 IBaseService

参数:

region - the region

getRegion

public String getRegion()

从接口复制的说明: IBaseService

Gets region.

指定者:

getRegion 在接口中 IBaseService

返回:

the region

setHost

public void setHost(String host)

从接口复制的说明: IBaseService

Sets host.

指定者:

setHost 在接口中 IBaseService

参数:

host - the host

setScheme

public void setScheme(String scheme)

从接口复制的说明: IBaseService

Sets scheme.

指定者:

setScheme 在接口中 IBaseService

参数:

scheme - the scheme

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

从接口复制的说明: IBaseService

Sets http client.

指定者:

setHttpClient 在接口中 IBaseService

参数:

httpClient - the http client

getServiceInfo

public ServiceInfo getServiceInfo()

setServiceInfo

public void setServiceInfo(ServiceInfo serviceInfo)

从接口复制的说明: IBaseService

Sets service info.

指定者:

setServiceInfo 在接口中 IBaseService

参数:

serviceInfo - the service info

getApiInfoList

public Map<String,ApiInfo> getApiInfoList()

getISigner

public ISignerV4 getISigner()

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

从接口复制的说明: IBaseService

Sets socket timeout.

指定者:

setSocketTimeout 在接口中 IBaseService

参数:

socketTimeout - the socket timeout

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

从接口复制的说明: IBaseService

Sets connection timeout.

指定者:

setConnectionTimeout 在接口中 IBaseService

参数:

connectionTimeout - the connection timeout

signSts2

public SecurityToken2 signSts2(Policy inlinePolicy,
                               long expire)
                        throws Exception

从接口复制的说明: IBaseService

Sign by sts2.

指定者:

signSts2 在接口中 IBaseService

参数:

inlinePolicy - the Policy

expire - expire time

返回:

the sts2

抛出:

Exception - the exception

proto

public RawResponse proto(String api,
                         List<org.apache.http.NameValuePair> params,
                         Map<String,String> header,
                         byte[] body,
                         String compressType)

指定者:

proto 在接口中 IBaseService

参数:

api - interface path like /PutLogs

params - query params

header - some special header for protobuf

body - request body

compressType - default not compress,support lz4

返回: