com.volcengine.service

Interface IBaseService

All Known Subinterfaces:

AdBlockerService, BusinessSecurityService, CDNService, CmsApiService, CmsPlatformService, ContentSecurityService, ExportReportsService, GameProtectService, IBillingService, ICloudTrailService, IIamService, IImageXService, IImpService, IKmsService, IPaasService, ISTSService, ITranslateService, IVEditService, IVisualService, IVodService, LivesaasService, LiveService, LogService, MaasService, MaasService, MonitorService, RtcService, SearchService, SecuritySourceService, SmsService, StreamConsumerService, StreamService, VideoAIoTService, VmsService

All Known Implementing Classes:

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

public interface IBaseService

The interface Service.

Method Summary

Modifier and Type	Method and Description
void	destroy() Free monitor thread
String	getAccessKey() Gets access key.
String	getRegion() Gets region.
String	getSecretKey() Gets secret key.
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.
RawResponse	post(String api, List<org.apache.http.NameValuePair> params, List<org.apache.http.NameValuePair> form) Post raw response.
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.
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.

Method Detail

setClientNoReuse

void setClientNoReuse()

Sets client no reuse.

getAccessKey

String getAccessKey()

Gets access key.

Returns:

the access key

setAccessKey

void setAccessKey(String accessKey)

Sets access key.

Parameters:

accessKey - the access key

getSecretKey

String getSecretKey()

Gets secret key.

Returns:

the secret key

setSecretKey

void setSecretKey(String secretKey)

Sets secret key.

Parameters:

secretKey - the secret key

getSessionToken

String getSessionToken()

Gets session token.

Returns:

the session token

setSessionToken

void setSessionToken(String sessionToken)

Sets session token.

Parameters:

sessionToken - the session token

setRegion

void setRegion(String region)

Sets region.

Parameters:

region - the region

getRegion

String getRegion()

Gets region.

Returns:

the region

setHost

void setHost(String host)

Sets host.

Parameters:

host - the host

setScheme

void setScheme(String scheme)

Sets scheme.

Parameters:

scheme - the scheme

setHttpClient

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

Sets http client.

Parameters:

httpClient - the http client

setServiceInfo

void setServiceInfo(ServiceInfo serviceInfo)

Sets service info.

Parameters:

serviceInfo - the service info

setSocketTimeout

void setSocketTimeout(int socketTimeout)

Sets socket timeout.

Parameters:

socketTimeout - the socket timeout

setConnectionTimeout

void setConnectionTimeout(int connectionTimeout)

Sets connection timeout.

Parameters:

connectionTimeout - the connection timeout

query

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

Query raw response.

Parameters:

api - the api

params - the params

Returns:

the raw response

Throws:

Exception - the exception

getSignUrl

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

Gets sign url.

Parameters:

api - the api

params - the params

Returns:

the sign url

Throws:

Exception - the exception

json

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

Json raw response.

Parameters:

api - the api

params - the params

body - the body

Returns:

the raw response

Throws:

Exception - the exception

post

RawResponse post(String api,
                 List<org.apache.http.NameValuePair> params,
                 List<org.apache.http.NameValuePair> form)
          throws Exception

Post raw response.

Parameters:

api - the api

params - the params

form - the form

Returns:

the raw response

Throws:

Exception - the exception

put

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

Put boolean.

Parameters:

url - the url

filePath - the file path

headers - the headers

Returns:

the boolean

Throws:

Exception - the exception

putData

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

Put binary data.

Parameters:

url - target url

data - binary data

headers - http headers

Returns:

put status

Throws:

Exception - exception

signSts2

SecurityToken2 signSts2(Policy inlinePolicy,
                        long expire)
                 throws Exception

Sign by sts2.

Parameters:

inlinePolicy - the Policy

expire - expire time

Returns:

the sts2

Throws:

Exception - the exception

proto

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

Parameters:

api - interface path like /PutLogs

params - query params

header - some special header for protobuf

body - request body

compressType - default not compress,support lz4

Returns:

destroy

void destroy()

Free monitor thread