com.aliyun.teaopenapi

Class Client

java.lang.Object

com.aliyun.teaopenapi.Client

public class Client
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	_ca
String	_cert
Integer	_connectTimeout
com.aliyun.credentials.Client	_credential
Boolean	_disableHttp2
String	_endpoint
Map<String,String>	_endpointMap
String	_endpointRule
String	_endpointType
GlobalParameters	_globalParameters
Map<String,String>	_headers
String	_httpProxy
String	_httpsProxy
String	_key
Integer	_maxIdleConns
String	_method
String	_network
String	_noProxy
String	_openPlatformEndpoint
String	_productId
String	_protocol
Integer	_readTimeout
String	_regionId
String	_signatureAlgorithm
String	_signatureVersion
String	_socks5NetWork
String	_socks5Proxy
com.aliyun.gateway.spi.Client	_spi
String	_suffix
String	_userAgent

Constructor Summary

Constructors

Constructor and Description
Client(Config config) Init client with Config

Method Summary

Modifier and Type	Method and Description
void	addRequestInterceptor(com.aliyun.tea.interceptor.RequestInterceptor interceptor)
void	addResponseInterceptor(com.aliyun.tea.interceptor.ResponseInterceptor interceptor)
void	addRuntimeOptionsInterceptor(com.aliyun.tea.interceptor.RuntimeOptionsInterceptor interceptor)
Map<String,?>	callApi(Params params, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime)
void	checkConfig(Config config) If the endpointRule and config.endpoint are empty, throw error
static Object	defaultAny(Object inputValue, Object defaultValue) If inputValue is not null, return it or return defaultValue
Map<String,?>	doRequest(Params params, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) Encapsulate the request and invoke the network
Map<String,?>	doROARequest(String action, String version, String protocol, String method, String authType, String pathname, String bodyType, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) Encapsulate the request and invoke the network
Map<String,?>	doROARequestWithForm(String action, String version, String protocol, String method, String authType, String pathname, String bodyType, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) Encapsulate the request and invoke the network with form body
Map<String,?>	doRPCRequest(String action, String version, String protocol, String method, String authType, String bodyType, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) Encapsulate the request and invoke the network
Map<String,?>	execute(Params params, OpenApiRequest request, com.aliyun.teautil.models.RuntimeOptions runtime) Encapsulate the request and invoke the network
String	getAccessKeyId() Get accesskey id by using credential
String	getAccessKeySecret() Get accesskey secret by using credential
String	getBearerToken() Get bearer token by credential
Map<String,String>	getRpcHeaders() get RPC header for debug
String	getSecurityToken() Get security token by using credential
String	getType() Get credential type by credential
String	getUserAgent() Get user agent
void	setGatewayClient(com.aliyun.gateway.spi.Client spi) set gateway client
void	setRpcHeaders(Map<String,String> headers) set RPC header for debug

Methods inherited from class java.lang.Object

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

Field Detail

_endpoint

public String _endpoint

_regionId

public String _regionId

_protocol

public String _protocol

_method

public String _method

_userAgent

public String _userAgent

_endpointRule

public String _endpointRule

_endpointMap

public Map<String,String> _endpointMap

_suffix

public String _suffix

_readTimeout

public Integer _readTimeout

_connectTimeout

public Integer _connectTimeout

_httpProxy

public String _httpProxy

_httpsProxy

public String _httpsProxy

_socks5Proxy

public String _socks5Proxy

_socks5NetWork

public String _socks5NetWork

_noProxy

public String _noProxy

_network

public String _network

_productId

public String _productId

_maxIdleConns

public Integer _maxIdleConns

_endpointType

public String _endpointType

_openPlatformEndpoint

public String _openPlatformEndpoint

_credential

public com.aliyun.credentials.Client _credential

_signatureVersion

public String _signatureVersion

_signatureAlgorithm

public String _signatureAlgorithm

_headers

public Map<String,String> _headers

_spi

public com.aliyun.gateway.spi.Client _spi

_globalParameters

public GlobalParameters _globalParameters

_key

public String _key

_cert

public String _cert

_ca

public String _ca

_disableHttp2

public Boolean _disableHttp2

Constructor Detail

Client

public Client(Config config)
       throws Exception

Init client with Config

Parameters:

config - config contains the necessary information to create a client

Throws:

Exception

Method Detail

doRPCRequest

public Map<String,?> doRPCRequest(String action,
                                  String version,
                                  String protocol,
                                  String method,
                                  String authType,
                                  String bodyType,
                                  OpenApiRequest request,
                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                           throws Exception

Encapsulate the request and invoke the network

Parameters:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

Returns:

the response

Throws:

Exception

doROARequest

public Map<String,?> doROARequest(String action,
                                  String version,
                                  String protocol,
                                  String method,
                                  String authType,
                                  String pathname,
                                  String bodyType,
                                  OpenApiRequest request,
                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                           throws Exception

Encapsulate the request and invoke the network

Parameters:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

pathname - pathname of every api

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

Returns:

the response

Throws:

Exception

doROARequestWithForm

public Map<String,?> doROARequestWithForm(String action,
                                          String version,
                                          String protocol,
                                          String method,
                                          String authType,
                                          String pathname,
                                          String bodyType,
                                          OpenApiRequest request,
                                          com.aliyun.teautil.models.RuntimeOptions runtime)
                                   throws Exception

Encapsulate the request and invoke the network with form body

Parameters:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

pathname - pathname of every api

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

Returns:

the response

Throws:

Exception

doRequest

public Map<String,?> doRequest(Params params,
                               OpenApiRequest request,
                               com.aliyun.teautil.models.RuntimeOptions runtime)
                        throws Exception

Encapsulate the request and invoke the network

Parameters:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

Returns:

the response

Throws:

Exception

execute

public Map<String,?> execute(Params params,
                             OpenApiRequest request,
                             com.aliyun.teautil.models.RuntimeOptions runtime)
                      throws Exception

Encapsulate the request and invoke the network

Parameters:

action - api name

version - product version

protocol - http or https

method - e.g. GET

authType - authorization type e.g. AK

bodyType - response body type e.g. String

request - object of OpenApiRequest

runtime - which controls some details of call api, such as retry times

Returns:

the response

Throws:

Exception

addRuntimeOptionsInterceptor

public void addRuntimeOptionsInterceptor(com.aliyun.tea.interceptor.RuntimeOptionsInterceptor interceptor)

addRequestInterceptor

public void addRequestInterceptor(com.aliyun.tea.interceptor.RequestInterceptor interceptor)

addResponseInterceptor

public void addResponseInterceptor(com.aliyun.tea.interceptor.ResponseInterceptor interceptor)

callApi

public Map<String,?> callApi(Params params,
                             OpenApiRequest request,
                             com.aliyun.teautil.models.RuntimeOptions runtime)
                      throws Exception

Throws:

Exception

getUserAgent

public String getUserAgent()
                    throws Exception

Get user agent

Returns:

user agent

Throws:

Exception

getAccessKeyId

public String getAccessKeyId()
                      throws Exception

Get accesskey id by using credential

Returns:

accesskey id

Throws:

Exception

getAccessKeySecret

public String getAccessKeySecret()
                          throws Exception

Get accesskey secret by using credential

Returns:

accesskey secret

Throws:

Exception

getSecurityToken

public String getSecurityToken()
                        throws Exception

Get security token by using credential

Returns:

security token

Throws:

Exception

getBearerToken

public String getBearerToken()
                      throws Exception

Get bearer token by credential

Returns:

bearer token

Throws:

Exception

getType

public String getType()
               throws Exception

Get credential type by credential

Returns:

credential type e.g. access_key

Throws:

Exception

defaultAny

public static Object defaultAny(Object inputValue,
                                Object defaultValue)
                         throws Exception

If inputValue is not null, return it or return defaultValue

Parameters:

inputValue - users input value

defaultValue - default value

Returns:

the final result

Throws:

Exception

checkConfig

public void checkConfig(Config config)
                 throws Exception

If the endpointRule and config.endpoint are empty, throw error

Parameters:

config - config contains the necessary information to create a client

Throws:

Exception

setGatewayClient

public void setGatewayClient(com.aliyun.gateway.spi.Client spi)
                      throws Exception

set gateway client

Parameters:

spi. -

Throws:

Exception

setRpcHeaders

public void setRpcHeaders(Map<String,String> headers)
                   throws Exception

set RPC header for debug

Parameters:

headers - headers for debug, this header can be used only once.

Throws:

Exception

getRpcHeaders

public Map<String,String> getRpcHeaders()
                                 throws Exception

get RPC header for debug

Throws:

Exception