com.qimen.api

Class DefaultQimenClient

java.lang.Object

com.qimen.api.DefaultQimenClient

All Implemented Interfaces:

QimenClient

public class DefaultQimenClient
extends Object
implements QimenClient

奇门API请求客户端。

Since:

Jan 26, 2016

Author:

fengsheng

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DefaultQimenClient(String serverUrl, String appKey, String appSecret)

Method Summary

Modifier and Type	Method and Description
void	enableHttpDns() 启用http dns
void	enableHttpDns(String onlineAppKey, String onlineAppSecret) 沙箱环境启用http dns
<T extends QimenResponse> T	execute(QimenRequest<T> request) 执行公开API请求。
<T extends QimenResponse> T	execute(QimenRequest<T> request, String session) 执行隐私API请求。
String	getServerUrl(String serverUrl)
String	getTopHttpDnsHost()
void	setConnectTimeout(int connectTimeout) 设置API请求的连接超时时间，默认为15秒。
void	setIgnoreSSLCheck(boolean ignore) 是否忽略HTTPS证书校验。
void	setNeedEnableLogger(boolean needEnableLogger) 是否记录API请求错误日志。
void	setNeedEnableParser(boolean needEnableParser) 是否把响应字符串解释为对象。
void	setReadTimeout(int readTimeout) 设置API请求的读超时时间，默认为30秒。
void	setUseGzipEncoding(boolean useGzipEncoding) 是否启用响应GZIP压缩

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

needEnableParser

protected boolean needEnableParser

useGzipEncoding

protected boolean useGzipEncoding

Constructor Detail

DefaultQimenClient

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

Method Detail

execute

public <T extends QimenResponse> T execute(QimenRequest<T> request)
                                    throws ApiException

Description copied from interface: QimenClient

执行公开API请求。

Specified by:

execute in interface QimenClient

Type Parameters:

T - 具体的API响应类

Parameters:

request - 具体的API请求类

Returns:

具体的API响应

Throws:

ApiException

execute

public <T extends QimenResponse> T execute(QimenRequest<T> request,
                                           String session)
                                    throws ApiException

Description copied from interface: QimenClient

执行隐私API请求。

Specified by:

execute in interface QimenClient

Type Parameters:

T - 具体的API响应类

Parameters:

request - 具体的API请求类

session - 用户授权码

Returns:

具体的API响应

Throws:

ApiException

setNeedEnableParser

public void setNeedEnableParser(boolean needEnableParser)

是否把响应字符串解释为对象。

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秒。

getServerUrl

public String getServerUrl(String serverUrl)

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