DefaultTaobaoClient (alibaba-dingtalk-service-sdk 2.0.0 API)

java.lang.Object
- com.taobao.api.DefaultTaobaoClient

All Implemented Interfaces:

TaobaoClient

Direct Known Subclasses:

AutoRetryTaobaoClient, BatchTaobaoClient, ClusterTaobaoClient, DefaultDingTalkClient, DefaultQimenCloudClient
```
public class DefaultTaobaoClient
extends Object
implements TaobaoClient
```
基于REST的TOP客户端。

Since:

1.0, Sep 13, 2009

Author:

carver.gu

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`appKey`
`protected String`	`appSecret`
`protected int`	`connectTimeout`
`protected String`	`format`
`protected boolean`	`needCheckRequest`
`protected boolean`	`needEnableParser`
`protected int`	`readTimeout`
`protected String`	`serverUrl`
`protected String`	`signMethod`
`protected boolean`	`useGzipEncoding`
`protected boolean`	`useSimplifyJson`

Constructor Summary

Constructors
Constructor and Description
`DefaultTaobaoClient(String serverUrl, String appKey, String appSecret)`
`DefaultTaobaoClient(String serverUrl, String appKey, String appSecret, String format)`
`DefaultTaobaoClient(String serverUrl, String appKey, String appSecret, String format, int connectTimeout, int readTimeout)`
`DefaultTaobaoClient(String serverUrl, String appKey, String appSecret, String format, int connectTimeout, int readTimeout, String signMethod)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enableHttpDns()` 启用http dns
`void`	`enableHttpDns(String onlineAppKey, String onlineAppSecret)` 沙箱环境启用http dns
`<T extends TaobaoResponse> T`	`execute(TaobaoRequest<T> request)` 执行公开API请求。
`<T extends TaobaoResponse> T`	`execute(TaobaoRequest<T> request, String session)` 执行隐私API请求。
`String`	`getAppKey()`
`String`	`getAppSecret()`
`int`	`getConnectTimeout()`
`String`	`getFormat()`
`Proxy`	`getProxy()`
`int`	`getReadTimeout()`
`protected String`	`getRealResponseType(String format, String responseType)`
`String`	`getRequestUrl()`
`String`	`getSdkVersion()`
`String`	`getServerUrl(String serverUrl, String apiName, String session, TaobaoHashMap appParams)`
`String`	`getSignMethod()`
`String`	`getTopHttpDnsHost()`
`protected RequestParametersHolder`	`invokeApi(RequestDTO request, String session, long start)`
`boolean`	`isNeedCheckRequest()`
`boolean`	`isNeedEnableParser()`
`boolean`	`isUseGzipEncoding()`
`boolean`	`isUseSimplifyJson()`
`void`	`resetServerUrl(String serverUrl)`
`void`	`setConnectTimeout(int connectTimeout)` 设置API请求的连接超时时间，默认为15秒。
`void`	`setIgnoreSSLCheck(boolean ignore)` 是否忽略HTTPS证书校验。
`void`	`setNeedCheckRequest(boolean needCheckRequest)` 是否在客户端校验请求参数。
`void`	`setNeedEnableLogger(boolean needEnableLogger)` 是否记录API请求错误日志。
`void`	`setNeedEnableParser(boolean needEnableParser)` 是否把响应字符串解释为对象。
`void`	`setProxy(Proxy proxy)`
`void`	`setReadTimeout(int readTimeout)` 设置API请求的读超时时间，默认为30秒。
`protected void`	`setRealFormat(String responseType)`
`void`	`setUseGzipEncoding(boolean useGzipEncoding)` 是否启用响应GZIP压缩
`void`	`setUseSimplifyJson(boolean useSimplifyJson)` 是否采用标准化的JSON格式返回。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serverUrl
```
protected String serverUrl
```

appKey
```
protected String appKey
```

appSecret
```
protected String appSecret
```

format
```
protected String format
```

signMethod
```
protected String signMethod
```

connectTimeout
```
protected int connectTimeout
```

readTimeout
```
protected int readTimeout
```

needCheckRequest
```
protected boolean needCheckRequest
```

needEnableParser
```
protected boolean needEnableParser
```

useSimplifyJson
```
protected boolean useSimplifyJson
```

useGzipEncoding
```
protected boolean useGzipEncoding
```

Constructor Detail

DefaultTaobaoClient

public DefaultTaobaoClient(String serverUrl,
                           String appKey,
                           String appSecret)

DefaultTaobaoClient

public DefaultTaobaoClient(String serverUrl,
                           String appKey,
                           String appSecret,
                           String format)

DefaultTaobaoClient

public DefaultTaobaoClient(String serverUrl,
                           String appKey,
                           String appSecret,
                           String format,
                           int connectTimeout,
                           int readTimeout)

DefaultTaobaoClient

public DefaultTaobaoClient(String serverUrl,
                           String appKey,
                           String appSecret,
                           String format,
                           int connectTimeout,
                           int readTimeout,
                           String signMethod)

Method Detail

execute
```
public <T extends TaobaoResponse> T execute(TaobaoRequest<T> request)
                                     throws ApiException
```
Description copied from interface: TaobaoClient

执行公开API请求。

Specified by:

execute in interface TaobaoClient

Type Parameters:

T - 具体的API响应类

Parameters:

request - 具体的API请求类

Returns:

具体的API响应

Throws:

ApiException

execute
```
public <T extends TaobaoResponse> T execute(TaobaoRequest<T> request,
                                            String session)
                                     throws ApiException
```
Description copied from interface: TaobaoClient

执行隐私API请求。

Specified by:

execute in interface TaobaoClient

Type Parameters:

T - 具体的API响应类

Parameters:

request - 具体的API请求类

session - 用户授权码

Returns:

具体的API响应

Throws:

ApiException

getServerUrl

public String getServerUrl(String serverUrl,
                           String apiName,
                           String session,
                           TaobaoHashMap appParams)

getSdkVersion
```
public String getSdkVersion()
```

setNeedCheckRequest

public void setNeedCheckRequest(boolean needCheckRequest)

是否在客户端校验请求参数。

setNeedEnableParser
```
public void setNeedEnableParser(boolean needEnableParser)
```
是否把响应字符串解释为对象。

setUseSimplifyJson
```
public void setUseSimplifyJson(boolean useSimplifyJson)
```
是否采用标准化的JSON格式返回。

setNeedEnableLogger

public void setNeedEnableLogger(boolean needEnableLogger)

是否记录API请求错误日志。

setIgnoreSSLCheck
```
public void setIgnoreSSLCheck(boolean ignore)
```
是否忽略HTTPS证书校验。

setUseGzipEncoding

public void setUseGzipEncoding(boolean useGzipEncoding)

是否启用响应GZIP压缩

setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
设置API请求的连接超时时间，默认为15秒。

setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
设置API请求的读超时时间，默认为30秒。

getTopHttpDnsHost
```
public String getTopHttpDnsHost()
```

enableHttpDns
```
public void enableHttpDns()
```
启用http dns

enableHttpDns

public void enableHttpDns(String onlineAppKey,
                          String onlineAppSecret)

沙箱环境启用http dns

Parameters:: onlineAppKey - 正式key; onlineAppSecret - 正式环境secret

resetServerUrl

public void resetServerUrl(String serverUrl)

getRequestUrl
```
public String getRequestUrl()
```

getAppKey
```
public String getAppKey()
```

invokeApi

protected RequestParametersHolder invokeApi(RequestDTO request,
                                            String session,
                                            long start)
                                     throws ApiException

Throws:: ApiException

setRealFormat

protected void setRealFormat(String responseType)

getRealResponseType

protected String getRealResponseType(String format,
                                     String responseType)

getProxy
```
public Proxy getProxy()
```

setProxy
```
public void setProxy(Proxy proxy)
```

getAppSecret
```
public String getAppSecret()
```

getFormat
```
public String getFormat()
```

getSignMethod
```
public String getSignMethod()
```

getConnectTimeout
```
public int getConnectTimeout()
```

getReadTimeout
```
public int getReadTimeout()
```

isNeedCheckRequest
```
public boolean isNeedCheckRequest()
```

isUseSimplifyJson
```
public boolean isUseSimplifyJson()
```

isUseGzipEncoding
```
public boolean isUseGzipEncoding()
```

isNeedEnableParser
```
public boolean isNeedEnableParser()
```

Class DefaultTaobaoClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serverUrl

appKey

appSecret

format

signMethod

connectTimeout

readTimeout

needCheckRequest

needEnableParser

useSimplifyJson

useGzipEncoding

Constructor Detail

DefaultTaobaoClient

DefaultTaobaoClient

DefaultTaobaoClient

DefaultTaobaoClient

Method Detail

execute

execute

getServerUrl

getSdkVersion

setNeedCheckRequest

setNeedEnableParser

setUseSimplifyJson

setNeedEnableLogger

setIgnoreSSLCheck

setUseGzipEncoding

setConnectTimeout

setReadTimeout

getTopHttpDnsHost

enableHttpDns

enableHttpDns

resetServerUrl

getRequestUrl

getAppKey

invokeApi

setRealFormat

getRealResponseType

getProxy

setProxy

getAppSecret

getFormat

getSignMethod

getConnectTimeout

getReadTimeout

isNeedCheckRequest

isUseSimplifyJson

isUseGzipEncoding

isNeedEnableParser